Skip to content

docker-guide.md

Latest commit

 

History

History
142 lines (103 loc) · 3.2 KB

docker-guide.md

File metadata and controls

142 lines (103 loc) · 3.2 KB
Raw

Ygégé - Docker deployment

Ygégé is a high performance indexer for YGG Torrent written in Rust. This guide explains how to deploy the official Docker image, configure the service and avoid YGG rate-limit by providing the correct credentials.

Prérequis

1. Préparer le dossier de configuration

Create a folder ygege at the root of your project (or in the folder of your choice):

mkdir -p ygege

2. Create and fill the file config.json

In the ygege folder, create a config.json file with your YGG information:

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

Important:

  • **Fill in the fields username and password with your YGG credentials correctly.
  • If the file is not present or incorrectly filled out, you may be rate-limit or blocked by YGG.

3. Sample compose.yml file

Place this file at the root of your project :

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

Alternative: Environment variables

Instead of config.json, you can use environment variables:

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

Important:

  • Fill in the fields username and password with your YGG credentials correctly.
  • If the environment variables are missing or misconfigured, you may be rate-limited or blocked by YGG.

4. Launch the service

In the folder where you have your compose.yml:

docker compose up -d

The service will then be available on your machine's 8715 port.

5. Verify the functioning

  • View the container logs:
docker logs -f ygege

6. Important notes

  • **Never share your config.json file with your YGG credentials.
  • The sessions folder must remain persistent to avoid having to reconnect each time you restart.
  • In case of wrong identifiers or wrong settings, YGG may block or limit you.

Useful links