4NK_node/docs/USAGE.md
root aad486cf54 Configuration hybride: Docker + services locaux
- Suppression services IA/monitoring du docker-compose.yml (externalisés vers 4NK_IA)
- Configuration Nginx local proxy vers ports Docker exposés
- Installation et configuration Grafana local pour monitoring
- Suppression doublon miniback (remplacé par coffre_back_mini)
- Documentation mise à jour pour architecture hybride
- Configuration monitoring compatible avec logs Docker
2025-09-08 22:12:18 +02:00

74 lines
3.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## USAGE
## Prérequis
- Docker et docker compose installés
- Nginx installé localement (hors Docker)
- Grafana installé localement (hors Docker)
## 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
### Services Docker
- Démarrer la stack applicative : `docker compose up -d`
### Services locaux
- Démarrer Nginx local : `systemctl start nginx`
- Démarrer Grafana local : `systemctl start grafana-server`
### Services IA (optionnel)
- Cloner le repository IA : `git clone https://git.4nkweb.com/4nk/4NK_IA.git`
- Basculer sur le tag dev : `cd 4NK_IA && git checkout dev`
- Suivre les instructions d'installation dans le repository 4NK_IA
### Accès aux services
- 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: `http://localhost/coffre/`
- Grafana: `http://localhost:3000/` (direct) ou `http://localhost/grafana/` (via Nginx)
## Commandes utiles
### Docker
- Mettre à jour les images: `docker compose pull`
- Voir les logs des services (montés): `tail -f modules/<service>/logs/*`
### Services locaux
- Voir les logs Nginx: `tail -f /var/log/nginx/4nk_node.access.log`
- Voir les logs Grafana: `journalctl -u grafana-server -f`
- Redémarrer Nginx: `systemctl restart nginx`
- Redémarrer Grafana: `systemctl restart grafana-server`
### Monitoring
- Grafana local: `http://localhost:3000/` (admin/admin)
- Logs des services Docker: montés dans `modules/*/logs/` et `projects/*/*/logs/`
- Configuration Grafana: `log/grafana-datasources.yml` et `log/grafana-dashboards.yml`
## Dépannage
### Docker
- 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 d'indisponibilité, utiliser des tags stables temporaires
- Conf Tor: `modules/tor/conf/tor.conf` est montée si l'image Tor supporte `/etc/tor/torrc`
### Services locaux
- Nginx: vérifier la configuration avec `nginx -t`
- Grafana: vérifier le statut avec `systemctl status grafana-server`
- Le reverse proxy Nginx pointe vers `127.0.0.1` avec les ports exposés par Docker Compose
- En cas de changement de ports dans `docker-compose.yml`, mettre à jour `conf/nginx/sites-enabled/4nk_node.conf`
## Accès depuis Windows (WSL2 ou VM Linux)
- WSL2 (Docker dans WSL): accéder via le navigateur Windows à `http://localhost/`. Si non accessible, utiliser lIP WSL (`wsl hostname -I` côté PowerShell) et ouvrir `http://<IP_WSL>/`.
- VM Linux (HyperV/VirtualBox/VMware): utiliser lIP de la VM (`ip addr` dans la VM) et ouvrir `http://<IP_VM>/`.
- Les routes exposées par Nginx: `/`, `/blindbit/`, `/sdk_storage/`, `/relay1/`, `/relay2/`, `/relay3/`, `/signer/`, `/coffre/`, `/grafana/`.
- Services IA: voir le repository [4NK_IA](https://git.4nkweb.com/4nk/4NK_IA.git) sur le tag `dev`