Installation - Migz93/3dq GitHub Wiki

Installation Guide

3DQ is designed to be easy to install and run using Docker. This guide will walk you through the installation process.

Prerequisites

  • Docker installed on your system
  • Basic knowledge of terminal/command line operations

Docker Installation

Option 1: Quick Start with Docker Run

# Create a directory for persistent data
mkdir -p ~/3dq-data

# Run the container
docker run -d \
  --name 3dq \
  -p 6123:6123 \
  -v ~/3dq-data:/config \
  -e CONFIG_DIR=/config \
  ghcr.io/migz93/3dq:latest

Option 2: Using Docker Compose (Recommended)

  1. Create a docker-compose.yml file:
version: '3'

services:
  3dq:
    image: ghcr.io/migz93/3dq:latest
    container_name: 3dq
    ports:
      - "6123:6123"
    volumes:
      - ./data:/config
    environment:
      - CONFIG_DIR=/config
    restart: unless-stopped
  1. Run the container:
docker-compose up -d

Accessing 3DQ

Once the container is running, you can access 3DQ by opening a web browser and navigating to:

http://localhost:6123

If you're running 3DQ on a different machine on your network, replace localhost with the IP address of that machine.

Data Persistence

All 3DQ data is stored in the /config directory inside the container, which is mapped to a directory on your host system (e.g., ~/3dq-data or ./data). This ensures your data persists even when the container is updated or removed.

The data includes:

  • SQLite database (3dq.sqlite)
  • Any other configuration files

Environment Variables

Variable Description Default
PORT Port for the Express server 6123
NODE_ENV Environment (development/production) development
CONFIG_DIR Directory for configuration and data ./config

Next Steps

After installation, proceed to the Quick Start Guide to begin using 3DQ.

⚠️ **GitHub.com Fallback** ⚠️