Aller au contenu principal

Configuration

Ce guide détaille toutes les options de configuration disponibles pour Ygégé.

Fichier config.json​

Le fichier de configuration principal est config.json. Il doit être placé à la racine du projet (installation manuelle) ou monté via un volume Docker.

Structure complète​

{
    "bind_ip": "0.0.0.0",
    "bind_port": 8715,
    "log_level": "info",
    "tmdb_token": null,
    "use_tor": false,
    "tor_proxy": "127.0.0.1:9050"
}

Options disponibles​

Configuration réseau​

ParamètreTypeDéfautDescription
bind_ipstring0.0.0.0Adresse IP d'écoute
bind_portnumber8715Port d'écoute du serveur
Personnaliser le port

Pour éviter les conflits de ports (ex: sur Windows), changez simplement BIND_PORT :

environment:
  BIND_PORT: "3000"  # Utilise le port 3000 au lieu de 8715
ports:
  - "3000:3000"

Le healthcheck s'adapte automatiquement grâce à $${BIND_PORT:-8715}.

Logging​

ParamètreTypeDéfautDescription
log_levelstringinfoNiveau de verbosité des logs

Niveaux disponibles:

  • trace : Maximum de détails (développement)
  • debug : Informations de débogage
  • info : Informations générales
  • warn : Avertissements uniquement
  • error : Erreurs uniquement

Métadonnées TMDB/IMDB​

ParamètreTypeDéfautDescription
tmdb_tokenstringnullToken API TMDB (optionnel)
info

Lorsque tmdb_token est configuré, les résolveurs TMDB et IMDB sont automatiquement activés ensemble.

Pour configurer TMDB/IMDB, consultez le guide d'intégration TMDB/IMDB.

Support Tor​

ParamètreTypeDéfautDescription
use_torbooleanfalseActiver le routage des connexions relay via Tor
tor_proxystring127.0.0.1:9050Adresse du proxy SOCKS5 Tor
info

Lorsque use_tor est activé, toutes les connexions aux relais Nostr sont routées via le proxy Tor. Tor doit être installé et en cours d'exécution sur votre machine.

Variables d'environnement​

Toutes les options peuvent également être définies via des variables d'environnement:

VariableÉquivalent config.json
BIND_IPbind_ip
BIND_PORTbind_port
LOG_LEVELlog_level
TMDB_TOKENtmdb_token
USE_TORuse_tor
TOR_PROXYtor_proxy
Priorité

Les variables d'environnement ont priorité sur le fichier config.json.

Exemple de configuration complète​

Pour Docker Compose​

services:
  ygege:
    image: uwucode/ygege:latest
    container_name: ygege
    restart: unless-stopped
    ports:
      - "8715:8715"
    environment:
      LOG_LEVEL: "info"
      TMDB_TOKEN: "votre_token_tmdb"  # Optionnel
      # USE_TOR: "true"               # Optionnel : activer Tor
      # TOR_PROXY: "127.0.0.1:9050"   # Optionnel : proxy Tor alternatif

Pour fichier config.json​

{
    "bind_ip": "0.0.0.0",
    "bind_port": 8715,
    "log_level": "info",
    "tmdb_token": "votre_token_tmdb",
    "use_tor": false,
    "tor_proxy": "127.0.0.1:9050"
}

Validation de la configuration​

Pour vérifier que votre configuration est correcte, consultez les logs au démarrage:

docker logs ygege

Vous devriez voir:

INFO Ygégé v0.x.x (commit: ..., branch: ..., built: ...)
INFO Tor routing disabled — connecting to relays directly
INFO Ranking Nostr relays by latency...
INFO Relay order: 1. wss://relay.ygg.gratis
INFO Categories initialized: 9 top-level categories

Prochaines étapes​