Velld

A self-hosted database backup management tool. Schedule automated backups, monitor status, and manage multiple databases from one place.

Documentation · Quick Start

Features

• Multiple database support (PostgreSQL, MySQL, MongoDB, Redis)
• Automated scheduling with cron syntax
• S3-compatible storage integration
• Built-in backup comparison and diff viewer
• Database restore functionality
• Email notifications for failed backups

Getting Started

curl -o docker-compose.yml https://raw.githubusercontent.com/dendianugerah/velld/main/docker-compose.prebuilt.yml

Create a .env file:

NEXT_PUBLIC_API_URL=http://localhost:8080

# Generate secure keys (IMPORTANT!)
JWT_SECRET=$(openssl rand -hex 32)
ENCRYPTION_KEY=$(openssl rand -hex 32)

# Admin credentials
ADMIN_USERNAME_CREDENTIAL=admin
ADMIN_PASSWORD_CREDENTIAL=changeme

# Registration (set to false in production)
ALLOW_REGISTER=true

Important: The ENCRYPTION_KEY must be a 64-character hex string. Don't use shell commands like $(openssl rand -hex 32) directly in .env files - they won't execute. Instead, run the command in your terminal and paste the output.

Generate keys properly:

# Generate and display keys
echo "JWT_SECRET=$(openssl rand -hex 32)"
echo "ENCRYPTION_KEY=$(openssl rand -hex 32)"

# Copy the output to your .env file

Start the containers:

docker compose up -d

Visit localhost:3000 and log in with your admin credentials.

For detailed setup instructions, see the Installation Guide.

Screenshots

Dashboard	Connections
Backup History

Documentation

Complete documentation is available at velld.vercel.app:

• Installation
• Database Configuration
• Troubleshooting

Development

Clone the repository:

git clone https://github.com/dendianugerah/velld.git
cd velld

With Docker:

cp .env.example .env
docker compose up -d

Without Docker - API:

cd apps/api
go mod download
go run cmd/api-server/main.go

Without Docker - Web:

cd apps/web
npm install
npm run dev

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

License

MIT License - see LICENSE for details.