4NK_node/docs/CONFIGURATION.md

54 lines
2.7 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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.

## Configuration des images, réseaux et paramètres
### Politique de tags et registres
- Référence: les services 4NK tirent les images `:dev` depuis `git.4nkweb.com`.
- Images externes stables: `dperson/torproxy:latest`, `ruimarinho/bitcoin-core:latest`.
- Blindbit: `git.4nkweb.com/4nk/blindbit-oracle:dev`.
- Relais: `git.4nkweb.com/4nk/sdk_relay:dev` (image unique pour 1/2/3).
- Signer/Storage/UI/Coffre: images `git.4nkweb.com/4nk/*:dev`.
### Réseaux et adresses
- `4nk_network` : `172.20.0.0/16` avec IP statiques et hostnames `.4nk.local` par service.
- `4nk_projects_net` : `172.21.0.0/16` réservé pour des projets additionnels.
### Montages (configuration, données, logs)
- Configuration : montée en lecture seule lorsque possible depuis `modules/*/conf` et `projects/*/*/conf`.
- Données : volumes persistants locaux (`modules/*/data`, `projects/*/*/data`).
- Journaux : `modules/*/logs`, `projects/*/*/logs`, et `./log` pour la stack dobservabilité.
### Variables denvironnement (exemples typés)
- Journalisation :
- `RUST_LOG` : chaîne (ex. `debug,bitcoincore_rpc=trace`).
- Bitcoin :
- `BITCOIN_COOKIE_PATH` : chemin absolu vers le cookie RPC.
- Synchronisation (selon besoins locaux) :
- `ENABLE_SYNC_TEST` : booléen (0/1) activant certains scénarios de test.
Nota : ces variables sont documentées pour référence et ne modifient pas la configuration existante.
### Healthchecks et supervision
- Services HTTP/WS instrumentés par des healthchecks (requêtes HTTP simples sur ports exposés).
- Stack observabilité : Promtail collecte les logs montés et les pousse vers Loki ; Grafana consomme Loki.
- Conformément à `USAGE.md`, Grafana peut être exécuté localement (hors Docker) ou via le service de lorchestrateur.
### Nginx et routage
- Nginx agit en reverseproxy et expose des routes stables : `/`, `/blindbit/`, `/sdk_storage/`, `/relay1|2|3/` (+ `/ws/`), `/signer/` (+ `/ws/`), `/coffre/`, `/grafana/`.
- Lexécution locale (hors Docker) est supportée ; les fichiers de configuration existants ne sont pas modifiés par ce document.
### Procédures usuelles
- Initialiser les configurations: copier tous les fichiers `*.exemple` vers leur homonyme sans suffixe.
- Vérifier les images : `docker-compose pull`.
- Démarrer la stack : `docker-compose up -d`.
- Consulter les logs : `docker-compose logs --tail=100`.
### Conclusion
Cette page consolide les paramètres clefs (tags `:dev`, topologie réseau, montages, variables, healthchecks, routage) afin dharmoniser lusage sans modifier les fichiers de configuration. Les évolutions futures seront répercutées dans `docs/ARCHITECTURE.md` et consignées dans `CHANGELOG.md`.