Skip to content

INSTALL.md

Latest commit

 

History

History
223 lines (168 loc) · 5.59 KB

INSTALL.md

File metadata and controls

223 lines (168 loc) · 5.59 KB
Raw

Installation Guide

Method 1: Quick Install (Recommended for Production)

One-command installation with systemd service:

curl -fsSL https://raw.githubusercontent.com/kulunkilabs/vibenetbackup/main/install.sh | sudo bash

What it does:

  • Installs Python 3.11+, git, and dependencies
  • Creates dedicated vibenetbackup system user
  • Clones repo to /opt/vibenetbackup
  • Sets up Python virtual environment
  • Generates secure .env with random admin password
  • Creates systemd service with security hardening
  • Starts the service on port 5005

Access the web UI:

http://<your-server-ip>:5005
Username: admin
Password: (shown during installation)

Service management:

sudo systemctl {start|stop|restart|status} vibenetbackup
sudo journalctl -u vibenetbackup -f  # View logs

Management commands:

cd /opt/vibenetbackup
./manage.sh show-password     # Show current password
./manage.sh set-password      # Change password
./manage.sh reset-password    # Generate new random password
./manage.sh status            # Show service status
./manage.sh logs              # View logs

To update:

curl -fsSL https://raw.githubusercontent.com/kulunkilabs/vibenetbackup/main/install.sh | sudo bash

Method 2: Git Clone + run.sh (Development)

For development, customization, or running without systemd:

git clone https://github.com/kulunkilabs/vibenetbackup.git
cd vibenetbackup
./run.sh

What it does:

  • Creates Python virtual environment (.venv)
  • Installs dependencies from requirements.txt
  • Creates .env from .env.example if missing
  • Starts server on http://localhost:5005

For production with this method:

cp .env.example .env
# Edit .env to set AUTH_PASSWORD, SECRET_KEY, etc.
nano .env
./run.sh

Method 3: Docker — Pre-built Image (Recommended)

Use the pre-built image from GitHub Container Registry — no need to clone the repo or build anything.

1. Download the compose file:

mkdir vibenetbackup && cd vibenetbackup
curl -fsSL https://raw.githubusercontent.com/kulunkilabs/vibenetbackup/main/docker/image/docker-compose.yml -o docker-compose.yml

2. Edit the environment variables directly in docker-compose.yml:

nano docker-compose.yml

Change at minimum SECRET_KEY and AUTH_PASSWORD:

    environment:
      - SECRET_KEY=change-me-to-a-random-secret-key
      - AUTH_PASSWORD=changeme-strong-password
      - CORS_ORIGINS=*

Generate a secure SECRET_KEY:

python3 -c "import secrets; print(secrets.token_urlsafe(32))"

3. Start:

docker compose up -d

Access: http://localhost:5005

To update:

docker compose pull
docker compose up -d

To run database migrations after an update (required when upgrading to a new release that adds columns):

docker compose exec vibenetbackup alembic upgrade head

The migration command reads DATABASE_URL from the container environment automatically.

Method 4: Docker — Build from Source

For development or customization, build the image yourself:

git clone https://github.com/kulunkilabs/vibenetbackup.git
cd vibenetbackup
cp .env.example .env
# Edit .env to set AUTH_PASSWORD, SECRET_KEY, etc.
nano .env
cd docker/build
docker compose up -d --build

To update:

cd vibenetbackup
git pull
cd docker/build
docker compose up -d --build

Building and Publishing the Image (maintainers)

To build a new image and push it to the container registry:

# From the repo root — builds, tags :1.5 + :latest, and pushes
bash docker/build-and-push.sh 1.5

The script will prompt for your registry credentials on first run. After it completes, docker compose pull in any Method 3 deployment will pick up the new image.

Docker Volumes

All data is persistent across container restarts:

Volume Path in Container Purpose
./data /app/data SQLite database
./backups /app/backups Backup files
./ssh_keys /app/ssh_keys SSH keys for devices

Upgrading Docker Engine

If you have an old version of Docker installed (e.g. docker-compose v1), upgrade to the official Docker Engine:

# Remove old Docker packages
sudo apt remove docker docker-engine docker.io containerd runc

# Add Docker's official GPG key and repository
sudo apt update
sudo apt install ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# Install latest Docker Engine with Compose plugin
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

# Verify
docker --version
docker compose version

Note: The new Docker uses docker compose (with a space) instead of the old docker-compose (with a hyphen).

Uninstallation

Quick Uninstall

curl -fsSL https://raw.githubusercontent.com/kulunkilabs/vibenetbackup/main/uninstall.sh | sudo bash
  • Keeps backup data and database by default
  • Asks before removing service user

Manual Uninstall

sudo systemctl stop vibenetbackup
sudo systemctl disable vibenetbackup
sudo rm -f /etc/systemd/system/vibenetbackup.service
sudo rm -rf /opt/vibenetbackup
sudo userdel vibenetbackup  # optional
sudo systemctl daemon-reload