Skip to main content

Installation with Docker

Ygégé is available as an official multi-architecture Docker image. This guide explains how to deploy and configure the service.

Prerequisites​

  • Docker installed on your system
  • Docker Compose (recommended for simplified management)
  • A valid YGG Torrent account

Quick Installation​

With Docker Run​

docker run -d \
  --name ygege \
  -p 8715:8715 \
  -v ./config:/config \
  -e YGG_USERNAME="your_username" \
  -e YGG_PASSWORD="your_password" \
  uwucode/ygege:latest

With Docker Compose​

Create a compose.yml file:

services:
  ygege:
    image: uwucode/ygege:latest
    container_name: ygege
    restart: unless-stopped
    ports:
      - "8715:8715"
    volumes:
      - ./config:/config
    environment:
      YGG_USERNAME: "your_username"
      YGG_PASSWORD: "your_password"
      LOG_LEVEL: "debug"
    healthcheck:
      test: ["CMD-SHELL", "curl --fail http://localhost:8715/health || exit 1"]
      interval: 1m30s
      timeout: 20s
      retries: 3
      start_period: 10s

Then start the service:

docker compose up -d

Configuration​

With config.json file​

Create a config/config.json file:

{
    "username": "your_ygg_username",
    "password": "your_password",
    "bind_ip": "0.0.0.0",
    "bind_port": 8715,
    "log_level": "debug"
}

With environment variables​

The following variables are supported:

VariableDescriptionDefault
YGG_USERNAMEYGG username-
YGG_PASSWORDYGG password-
BIND_IPListening IP address0.0.0.0
BIND_PORTListening port8715
LOG_LEVELLog level (trace, debug, info, warn, error)info

Available Docker Tags​

TagDescription
latestLatest stable version
stableAlias for latest
noupxVersion without UPX compression (for Synology)
0.6.2Specific version
developDevelopment version

For systems with older architectures​

If you encounter segmentation faults on older architectures or certain NAS (like Synology), use the noupx image:

services:
  ygege:
    image: uwucode/ygege:noupx
    # ... rest of configuration

Verification​

Once the container is started, verify it's working:

curl http://localhost:8715/health

You should receive an OK response.

Next Steps​