Docker Compose

This guide will help you deploy Databasement using Docker Compose. This method is ideal when you want to run Databasement alongside its own dedicated database container.

Prerequisites

• Docker and Docker Compose

Quick Start

1. Create Project Directory

mkdir databasement && cd databasement

2. Generate Application Key

docker run --rm davidcrty/databasement:latest php artisan key:generate --show

Save this key for the next step.

Important

The APP_KEY must be identical in both app and worker services. This key is used to encrypt sensitive data like database passwords. If the keys don't match, the worker will fail to decrypt credentials when running backup jobs.

3. Create docker-compose.yml

SQLite (Simple Setup)

docker-compose.yml

services:
  app:
    image: davidcrty/databasement:latest
    container_name: databasement
    restart: unless-stopped
    ports:
      - "2226:2226"
    environment:
      APP_URL: http://localhost:2226
      APP_KEY: base64:your-generated-key-here
      DB_CONNECTION: sqlite # or mysql, postgres
      DB_DATABASE: /data/database.sqlite
    volumes:
      - app-data:/data
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:2226"]
      interval: 10s
      timeout: 5s
      retries: 5

  worker:
    image: davidcrty/databasement:latest
    container_name: databasement-worker
    restart: unless-stopped
    command: sh -c "php artisan db:wait && php artisan queue:work --queue=backups,default --tries=3 --timeout=3600 --sleep=3 --max-jobs=1000"
    environment:
      APP_URL: http://localhost:2226
      APP_KEY: base64:your-generated-key-here
      DB_CONNECTION: sqlite # or mysql, postgres
      DB_DATABASE: /data/database.sqlite
    volumes:
      - app-data:/data
    depends_on:
      - app

volumes:
  app-data:

MySQL (Production Setup)

docker-compose.yml

services:
  app:
    image: davidcrty/databasement:latest
    container_name: databasement
    restart: unless-stopped
    ports:
      - "2226:2226"
    environment:
      APP_URL: http://localhost:2226
      APP_KEY: base64:your-generated-key-here
      DB_CONNECTION: mysql
      DB_HOST: mysql
      DB_PORT: 3306
      DB_DATABASE: databasement
      DB_USERNAME: databasement
      DB_PASSWORD: your-secure-password
    volumes:
      - app-data:/data
    depends_on:
      mysql:
        condition: service_healthy
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:2226"]
      interval: 10s
      timeout: 5s
      retries: 5

  worker:
    image: davidcrty/databasement:latest
    container_name: databasement-worker
    restart: unless-stopped
    command: sh -c "php artisan db:wait && php artisan queue:work --queue=backups,default --tries=3 --timeout=3600 --sleep=3 --max-jobs=1000"
    environment:
      APP_URL: http://localhost:2226
      APP_KEY: base64:your-generated-key-here
      DB_CONNECTION: mysql
      DB_HOST: mysql
      DB_PORT: 3306
      DB_DATABASE: databasement
      DB_USERNAME: databasement
      DB_PASSWORD: your-secure-password
    volumes:
      - app-data:/data
    depends_on:
      mysql:
        condition: service_healthy

  mysql:
    image: mysql:8.0
    container_name: databasement-mysql
    restart: unless-stopped
    environment:
      MYSQL_ROOT_PASSWORD: your-root-password
      MYSQL_DATABASE: databasement
      MYSQL_USER: databasement
      MYSQL_PASSWORD: your-secure-password
    volumes:
      - mysql-data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  app-data:
  mysql-data:

Important

The APP_KEY must be identical in both app and worker services. This key is used to encrypt sensitive data like database passwords. If the keys don't match, the worker will fail to decrypt credentials when running backup jobs.

tip

The worker service runs the Laravel queue worker as a separate container. This provides better stability and allows independent restarts without affecting the web application. The worker processes backup and restore jobs from the queue.

4. Start the Services

docker compose up -d

5. Access the Application

Open http://localhost:2226 in your browser.

note

To expose your Databasement instance with HTTPS, you can use Traefik as a reverse proxy. For detailed instructions on how to configure Traefik with Docker, please refer to the official Traefik documentation.

Production Setup (External Database)

For production, we recommend using MySQL or PostgreSQL instead of SQLite. Check the database configuration guide for more information.