Skip to main content

Getting Started Guide

This guide walks you step by step through installing and configuring Ygégé, from initial setup to integration with your media management applications.

Choosing an Installation Method​

Advantages:

  • One-command installation
  • Simplified updates
  • Complete isolation
  • Multi-architecture (AMD64, ARM64, ARMv7)

For whom?

  • Users with Docker already installed
  • Synology, QNAP NAS, etc.
  • Linux servers
  • Windows users with WSL2

👉 Docker Guide

Manual Installation (Advanced)​

Advantages:

  • Full control
  • No Docker dependency
  • Native performance

For whom?

  • Developers
  • Servers without Docker
  • Experienced users
Pre-compiled binaries available

With each release, pre-compiled binaries are provided for multiple platforms (Linux, Windows, macOS). Download them directly from the releases page.

👉 To compile yourself, see the GitHub README

Quick Installation (Docker Compose)​

Step 1: Create Configuration Directory​

mkdir -p ~/ygege/config
cd ~/ygege

Step 2: Create compose.yml File​

services:
  ygege:
    image: uwucode/ygege:latest
    container_name: ygege
    restart: unless-stopped
    ports:
      - "8715:8715"
    environment:
      LOG_LEVEL: "info"
      BIND_IP: "0.0.0.0"
      BIND_PORT: "8715"
      # TMDB_TOKEN: "your_tmdb_token"  # Optional: for TMDB/IMDB ID searches
      # USE_TOR: "true"               # Optional: enable Tor routing

    # Health check to verify proper operation
    healthcheck:
      test: ["CMD-SHELL", "curl -f http://localhost:8715/health || exit 1"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 30s

Step 3: Start the Service​

docker compose up -d

Step 4: Verify Operation​

# Check logs
docker compose logs -f ygege

# Test the API
curl http://localhost:8715/health

You should see:

INFO Ygégé v0.x.x (commit: ..., branch: ..., built: ...)
INFO Using Nostr relay: wss://relay.ygg.gratis
INFO Categories initialized: 9 top-level categories

You can also access the information page in your browser: http://localhost:8715/

This page displays real-time status of all Ygégé components:

  • Nostr relay connectivity
  • Search functionality
  • TMDB/IMDB integration

Basic Configuration​

No authentication required

ygg.gratis is a public tracker. No account or credentials are needed to use Ygégé.

Network Ports​

By default, Ygégé listens on port 8715. If this port is already in use:

ports:
  - "9090:8715"  # Use port 9090 on your machine

Or modify the port in the configuration:

environment:
  BIND_PORT: "9090"
ports:
  - "9090:9090"

Integration with Your Applications​

Once Ygégé is configured, integrate it with your applications:

Prowlarr automatically synchronizes indexers with Sonarr, Radarr, Lidarr, etc.

  1. Download the ygege.yml file
  2. Place it in {prowlarr_appdata}/Definitions/Custom/
  3. Restart Prowlarr
  4. Add the Ygégé indexer in Prowlarr

👉 Complete Prowlarr Guide

Jackett​

Alternative to Prowlarr, simpler but requires manual configuration.

  1. Download the ygege.yml file
  2. Place it in {jackett_appdata}/cardigann/definitions/
  3. Restart Jackett
  4. Add the Ygégé indexer in Jackett

👉 Complete Jackett Guide

Direct API Usage​

You can also use the REST API directly:

# Search for a torrent
curl "http://localhost:8715/search?q=breaking+bad&season=1&ep=1"

# Download a torrent
curl -O "http://localhost:8715/download?id=1234567"

👉 Complete API Documentation

Quick Troubleshooting​

Service Won't Start​

  1. Check the logs:

    docker compose logs ygege

  2. Verify port 8715 is available:

    # Linux/Mac
    lsof -i :8715

    # Windows
    netstat -ano | findstr :8715

No Search Results​

Possible causes:

  1. Nostr relay unreachable → Check logs (INFO Using Nostr relay: ...)
  2. Query too specific → Try with fewer keywords
  3. Misconfigured categories → Check Prowlarr/Jackett configuration

"Connection Refused" Error​

The service is not accessible:

  1. Verify the container is running:

    docker ps | grep ygege

  2. Verify the port is properly exposed:

    docker compose ps

  3. Test from within the container:

    docker exec ygege curl http://localhost:8715/health

Updates​

# Download the latest image
docker compose pull

# Restart with the new image
docker compose up -d

# Clean up old images
docker image prune -f

Check installed version​

curl http://localhost:8715/status | jq '.version'

Next Steps​

Now that Ygégé is installed and configured:

  1. 📖 Configure Prowlarr - Automatic synchronization with your *arr applications
  2. 🔧 Advanced Configuration - TMDB/IMDB, logging, etc.
  3. 📡 Explore the API - Use Ygégé in your own scripts
  4. 🐳 Advanced Docker Options - Tags, architectures, health checks

Need Help?​

Contribution

Ygégé is open-source! Feel free to contribute on GitHub.