Synology NAS Docker Compose

This is a customized version of the advanced Docker Compose configuration for running AdamRMS with a MySQL database inside of a Synology NAS. This configuration is suitable for production use, and includes additional services such as a MinIO Server for S3 Storage and mysql backups.

Upload the docker-compose.yml file in the same directory as the .env on your Synology.

Edit the docker-compose.yml and update:

• MINIO_DOMAIN
• MINIO_ROOT_PASSWORD

services:
  adamrms_db:
    image: index.docker.io/mysql/mysql-server:8.0
    command: --default-authentication-plugin=mysql_native_password --innodb-thread-concurrency=0 --sort_buffer_size=512K
    container_name: adamrms_db
    #ports: # Disable this if you would like to keep the database on the local machine only (recommended)
    #  - 3306:3306
    volumes:
      - adamrms_db_data:/var/lib/mysql
      - /etc/localtime:/etc/localtime:ro
    restart: always
    environment:
      - MYSQL_DATABASE=adamrms
      - MYSQL_ROOT_HOST=%
      - MYSQL_USER=userDocker
      - MYSQL_PASSWORD=passDocker
    env_file:
      - .env
    healthcheck:
      test:
        [
          "CMD",
          "mysqladmin",
          "ping",
          "-h",
          "localhost",
          "-u",
          "root",
          "-p$$MYSQL_ROOT_PASSWORD",
        ]
      timeout: 20s
      retries: 10
  adamrms:
    image: ghcr.io/adam-rms/adam-rms:latest
    container_name: adamrms
    restart: always
    depends_on:
      adamrms_db:
        condition: service_healthy
    environment:
      - DB_HOSTNAME=adamrms_db
      - DB_DATABASE=adamrms
      - DB_USERNAME=userDocker
      - DB_PASSWORD=passDocker
      - DB_PORT=3306
      - DEV_MODE=false
      - CONFIG_AWS_S3_KEY=minioadmin
      - CONFIG_AWS_S3_SECRET=CHANGE_THIS_MINO_PW
      - CONFIG_AWS_S3_BUCKET=adamrms
      - CONFIG_AWS_S3_BROWSER_ENDPOINT=https://yourPublicMinio.url:9001/adamrms
      - CONFIG_AWS_S3_SERVER_ENDPOINT=http://adamrms_minio:9001/adamrms
      - CONFIG_AWS_S3_ENDPOINT_PATHSTYLE=Enabled
      - CONFIG_AWS_S3_REGION=us-east-1
    user: root
    ports:
    - "8089:80"
  adamrms_mysql-backup:
    image: index.docker.io/databack/mysql-backup:1.0.0-rc5
    restart: unless-stopped
    container_name: adamrms_mysql-backup
    command: dump
    environment:
      - DB_SERVER=adamrms_db
      - DB_PORT=3306
      - DB_USER=userDocker
      - DB_PASS=passDocker
      - DB_NAMES=adamrms
      - NO_DATABASE_NAME=true
      - DB_DUMP_FREQUENCY=60 #Hourly
      - DB_DUMP_BEGIN=+2
      - COMPRESSION=gzip
      - DB_DUMP_SAFECHARS=true
      - NICE=true
      - DB_DUMP_TARGET=s3://adamrms-database-backup
      - AWS_ACCESS_KEY_ID=minioadmin
      - AWS_SECRET_ACCESS_KEY=CHANGE_THIS_MINO_PW
      - AWS_ENDPOINT_URL=http://adamrms_minio:9001
      - AWS_DEFAULT_REGION=us-east-1
    env_file:
      - .env
    depends_on:
      adamrms_db:
        condition: service_healthy
    volumes:
      - /etc/localtime:/etc/localtime:ro
  adamrms_watchtower:
    image: index.docker.io/containrrr/watchtower:1.7.1
    container_name: adamrms_watchtower
    restart: always
    environment:
      - WATCHTOWER_CLEANUP=true
      - WATCHTOWER_POLL_INTERVAL=60
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
  adamrms_minio:
    image: quay.io/minio/minio:latest
    container_name: adamrms_minio
    restart: always
    command: server /data --console-address ":9001"
    environment:
      MINIO_ROOT_USER: minioadmin
      MINIO_ROOT_PASSWORD: CHANGE_THIS_MINO_PW  # Secret Key
      MINIO_REGION_NAME: us-east-1
      MINIO_API_CORS_ALLOW_ORIGIN: '*'
      MINIO_DOMAIN: https://yourPublicMinio.url
    ports:
      - "9000:9000"   # S3 API Endpoint
      - "9001:9001"   # Web Console
    volumes:
      - adamrms_minio_data:/data
volumes:
  adamrms_db_data: {}
  adamrms_minio_data: {}

Environment Variables

Place the following environment variables in a .env file in the same directory as the docker-compose.yml file.

# For the remote mysql access, set a root password
MYSQL_ROOT_PASSWORD=

Create the Project

Go to your Synology Nas -> Container Manager -> Projects -> Create.

Give it a Name and selec the Folder where you stored your docker-compose.yml, then select use existing.

Create Bucket in MinIO

Go to http://yourNasIp:9000 and login with the Username minioadmin and your given Password (CHANGE_THIS_MINO_PW).

Create a new Container adamrms and adamrms-database-backup

Now everything should be ready to upload your Files.