4NK_node/docs/USAGE.md

1.6 KiB
Raw Blame History

USAGE

Prérequis

  • Docker et docker compose installés
  • Nginx utilisé via le service nginx de l'orchestrateur

Installation locale

  • Cloner le dépôt et se placer à la racine
  • Vérifier la présence des répertoires modules/ et projects/ avec conf/, data/, logs/, scripts/
  • Vérifier la disponibilité des images taggées :dev (en cours de création) ou utiliser des tags stables le cas échéant

Démarrage

  • Démarrer la stack applicative : docker compose up -d
  • Démarrer la stack de monitoring (Loki/Promtail/Grafana) si souhaité : docker compose -f log-monitoring.yml up -d
  • Accéder aux services via Nginx :
    • IHM: http://localhost/
    • Blindbit: http://localhost/blindbit/
    • SDK Storage: http://localhost/sdk_storage/
    • Relais HTTP: http://localhost/relay1/, /relay2/, /relay3/
    • Relais WebSocket: ws://localhost/relay1/ws/ (idem relay2, relay3)
    • Signer WS: ws://localhost/signer/ws/; HTTP: http://localhost/signer/
    • Coffre front: http://localhost/coffre/

Commandes utiles

  • Mettre à jour les images: docker compose pull
  • Voir les logs Nginx: tail -f log/nginx/4nk_node.access.log
  • Voir les logs des services (montés): tail -f modules/<service>/logs/*
  • Logs Promtail/Loki/Grafana: voir log/ et log-monitoring.yml

Dépannage

  • Vérifier les hostnames Docker internes (DNS du réseau 4nk_network): voir docker-compose.yml
  • Les tags :dev sont en cours de création; en cas dindisponibilité, utiliser des tags stables temporaires
  • Conf Tor: modules/tor/conf/tor.conf est montée si l'image Tor supporte /etc/tor/torrc