Installation

Only Docker installation is supported.

Quick Start

⚠️ Critical: Directory Permissions ⚠️

You MUST create the bind mount directory (data) before starting the container. The container runs as user 1000:1000, not root, and cannot modify host directory permissions for you.

If you skip step 1, Docker will create the directory as root, and the container will fail to start because of permission errors.

Custom paths: Want your data elsewhere?

Create the directory first:

mkdir -p ~/Documents/gdluxx

Then update your compose volumes to: - ~/Documents/gdluxx:/app/data

1. ⚠️ Create the data directory first ⚠️

   mkdir data

2. Copy environment file.

   • Or you can copy it from here

   cp .env.example .env

3. Generate your AUTH_SECRET. (Windows Note)

   openssl rand -hex 32

4. Paste your generated AUTH_SECRET into your .env file.

   AUTH_SECRET=your-super-secret-auth-key-change-this

5. Configure your ORIGIN.

   The ORIGIN environment variable is mandatory. It tells gdluxx what domain to expect for all requests. This helps prevent CSRF issues.

   In your .env file, set ORIGIN to the URL you will use to access the application.

   • Most common: If you're accessing the app via http://localhost:7755, you don't need to do anything. The docker-compose.yml file already sets a default ORIGIN of http://localhost:7755.
   • Network access: If you're accessing the app from another device on your network, set ORIGIN to your server's IP address so it's exposed.
   • Reverse proxy: If you're using a reverse proxy with HTTPS, set ORIGIN to your domain.

   For more specifics, see the comments in the .env.example file.

6. Create a docker-compose.yml file.

   name: gdluxx
   
   services:
     gdluxx:
       image: ghcr.io/gdluxx/gdluxx:latest
       container_name: gdluxx
       ports:
         - '7755:7755'
       volumes:
         - ./data:/app/data
       environment:
         - AUTH_SECRET=${AUTH_SECRET}
         - ORIGIN=${ORIGIN:-http://localhost:7755}
       restart: unless-stopped
       deploy:
         restart_policy:
           condition: on-failure
           max_attempts: 3
           delay: 3s

7. Run docker compose up -d.

   docker compose up -d

Windows Users

If you are on Windows, you may not have openssl. You can use the Windows Subsystem for Linux (WSL), Git Bash, or an alternative tool like CryptoTool's OpenSSL to generate the secret.

Also, I know nothing about Windows these days. I've never used WSL, Git Bash, or Docker on Windows. Maybe you do have openssl. Unfortunately, I won't be able to assist with troubleshooting any issues that may arise if you're on Windows.

This also means I've not tested any of this on Windows.