Skip to main content

Configuration

This guide details all available configuration options for Ygégé.

config.json File​

The main configuration file is config.json. It should be placed in the /config folder (Docker) or at the project root (manual installation).

Complete Structure​

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

Available Options​

YGG Authentication​

ParameterTypeRequiredDescription
usernamestring✅YGG Torrent username
passwordstring✅YGG Torrent password
Warning

Without valid credentials, you will be rate-limited by YGG and the service won't work properly.

Network Configuration​

ParameterTypeDefaultDescription
bind_ipstring0.0.0.0Listening IP address
bind_portnumber8715Server listening port

Logging​

ParameterTypeDefaultDescription
log_levelstringinfoLog verbosity level

Available levels:

  • trace: Maximum details (development)
  • debug: Debug information
  • info: General information
  • warn: Warnings only
  • error: Errors only

TMDB/IMDB Metadata​

ParameterTypeDefaultDescription
tmdb_api_keystring""TMDB API key (optional)

Environment Variables​

All options can also be set via environment variables:

Variableconfig.json equivalent
YGG_USERNAMEusername
YGG_PASSWORDpassword
BIND_IPbind_ip
BIND_PORTbind_port
LOG_LEVELlog_level
TMDB_TOKENtmdb_token
Priority

Environment variables have priority over config.json file.

Complete Configuration Example​

For Docker Compose​

services:
  ygege:
    image: uwucode/ygege:latest
    container_name: ygege
    restart: unless-stopped
    ports:
      - "8715:8715"
    volumes:
      - ./config:/config
    environment:
      YGG_USERNAME: "my_username"
      YGG_PASSWORD: "my_password"
      LOG_LEVEL: "info"
      TMDB_TOKEN: "your_tmdb_token"

For config.json File​

{
    "username": "my_username",
    "password": "my_password",
    "bind_ip": "0.0.0.0",
    "bind_port": 8715,
    "log_level": "debug",
    "tmdb_token": "your_tmdb_token"
}

Configuration Validation​

To verify your configuration is correct, check the logs at startup:

docker logs ygege

You should see:

[INFO] Configuration loaded successfully
[INFO] Connecting to YGG Torrent...
[INFO] Authentication successful
[INFO] Server started on 0.0.0.0:8715

Next Steps​