Introduction to Ygégé
Welcome to the Ygégé documentation! 🚀
What is Ygégé?
Ygégé is a high-performance indexer for ygg.gratis, written in Rust. It bridges ygg.gratis with your media management applications (Prowlarr, Jackett, Sonarr, Radarr, etc.) via the Nostr protocol (NIP-35).
Why Ygégé?
- ⚡ Exceptional Performance: Written in Rust for maximum speed
- 🔓 No Account Required: ygg.gratis is a public tracker, no credentials needed
- 📡 Nostr Protocol: Direct connection to the
wss://relay.ygg.gratisrelay - 🐳 Simplified Deployment: Multi-architecture Docker images (AMD64, ARM64, ARMv7)
- 🔍 Complete Search: Full support for ygg.gratis categories and filters
- 🎬 Enriched Metadata: Automatic TMDB/IMDB integration
- 🔌 Universal Compatibility: Works with Prowlarr, Jackett, and all *arr applications
- 🧅 Tor Support: Optional routing of connections through Tor
Quick Start
New to Ygégé?
Follow the Getting Started Guide for a complete step-by-step installation.
30-Second Installation
# Create configuration directory
mkdir -p ~/ygege && cd ~/ygege
# Download and start with Docker Compose
curl -o compose.yml https://raw.githubusercontent.com/UwUDev/ygege/master/docker/compose.yml
docker compose up -d
No configuration required
ygg.gratis is public — no account or credentials to configure. Ygégé works immediately after startup.
Documentation Navigation
🚀 Installation
- Getting Started Guide - Complete installation and configuration
- Docker Installation - Detailed Docker guide
- Build from Source - For developers
🔌 Integrations
📖 Developer
- API Documentation - Complete REST API reference
- TMDB/IMDB Configuration - Metadata enrichment
❓ Support
- FAQ - Frequently asked questions
- GitHub Issues - Report a bug or get help
Need Help?
- 📖 Check the FAQ for common questions
- 🐛 Open an issue on GitHub
- 💬 Browse existing issues
Open Source
Ygégé is open-source and welcomes your contributions on GitHub!