4nk/4NK_node
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs(network,usage): document mapping services↔ports↔mounts, nginx routes, grafana path

Browse Source
This commit is contained in:
Debian 2025-09-08 14:43:11 +00:00
parent 636482ac55
commit 2646aed0a2
3 changed files with 36 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -51,3 +51,4 @@ tests/reports/
certs/
*.log
# Ignore real configuration files, but keep example configs
tor_data/

45
docs/NETWORK.md
View File

@ -1,13 +1,32 @@
tor: hostname=tor.4nk.local, ip=172.20.0.10
bitcoin: hostname=bitcoin.4nk.local, ip=172.20.0.11
blindbit: hostname=blindbit.4nk.local, ip=172.20.0.12
sdk_storage: hostname=sdk-storage.4nk.local, ip=172.20.0.13
sdk_relay1: hostname=sdk-relay1.4nk.local, ip=172.20.0.14
sdk_relay2: hostname=sdk-relay2.4nk.local, ip=172.20.0.15
sdk_relay3: hostname=sdk-relay3.4nk.local, ip=172.20.0.16
sdk_signer: hostname=sdk-signer.4nk.local, ip=172.20.0.17
ihm_client: hostname=ihm-client.4nk.local, ip=172.20.0.18
miniback-postgres: hostname=miniback-postgres.4nk.local, ip=172.20.0.30
miniback: hostname=miniback.4nk.local, ip=172.20.0.31
coffre_front: hostname=coffre-front.4nk.local, ip=172.20.0.32
coffre_back_mini: hostname=coffre-back-mini.4nk.local, ip=172.20.0.33
## Réseau et cartographie des services
### Sous-réseaux
- 4nk_network: 172.20.0.0/16 (services applicatifs, IP statiques et hostnames fixés)
- 4nk_projects_net: 172.21.0.0/16 (réservé, aucun service attaché pour l’instant)
### Tableau de mapping
| Service | Hostname | IP | Ports exposés | Montages conf/data/logs | Nginx (routes) | Dépendances |
|---|---|---|---|---|---|---|
| tor | tor.4nk.local | 172.20.0.10 | 9050, 9051 | conf:/etc/tor/torrc(ro), data:/var/lib/tor, logs:/var/log/tor | — | — |
| bitcoin | bitcoin.4nk.local | 172.20.0.11 | 38333, 38332, 29000 | conf:/home/bitcoin/.bitcoin/bitcoin.conf(ro), data:/home/bitcoin/.bitcoin, logs:/home/bitcoin/.bitcoin/logs | — | tor |
| blindbit | blindbit.4nk.local | 172.20.0.12 | 8000 | conf:/blindbit/blindbit.toml(ro), data:/blindbit, logs:/blindbit/logs | /blindbit/ → :8000 | bitcoin |
| sdk_storage | sdk-storage.4nk.local | 172.20.0.13 | 8081 | conf:/usr/local/bin/sdk_storage.conf(ro), logs:/app/logs | /sdk_storage/ → :8081 | blindbit |
| sdk_relay1 | sdk-relay1.4nk.local | 172.20.0.14 | 8090(ws), 8091(http) | conf:/home/bitcoin/.conf(ro), logs:/home/bitcoin/logs | /relay1/, /relay1/ws/ | sdk_storage |
| sdk_relay2 | sdk-relay2.4nk.local | 172.20.0.15 | 8092(ws), 8093(http) | conf:/home/bitcoin/.conf(ro), logs:/home/bitcoin/logs | /relay2/, /relay2/ws/ | sdk_storage |
| sdk_relay3 | sdk-relay3.4nk.local | 172.20.0.16 | 8094(ws), 8095(http) | conf:/home/bitcoin/.conf(ro), logs:/home/bitcoin/logs | /relay3/, /relay3/ws/ | sdk_storage |
| sdk_signer | sdk-signer.4nk.local | 172.20.0.17 | 9090(ws), 9092(http) | conf:/usr/local/bin/sdk_signer.conf(ro), data:/app/data, logs:/usr/src/app/logs | /signer/, /signer/ws/ | sdk_relay1/2/3 |
| ihm_client | ihm-client.4nk.local | 172.20.0.18 | 80, 3003 | logs:/var/log/ihm_client | / (→:80), /coffre/ (→coffre_front:3003) | sdk_signer |
| miniback-postgres | miniback-postgres.4nk.local | 172.20.0.30 | 5432 | data:/var/lib/postgresql/data(volume) | — | — |
| miniback | miniback.4nk.local | 172.20.0.31 | — | logs:/logs, env:.env(ro) | /miniback/ (si HTTP) | miniback-postgres |
| coffre_front | coffre-front.4nk.local | 172.20.0.32 | 3003 | logs:/logs | /coffre/ → :3003 | — |
| coffre_back_mini | coffre-back-mini.4nk.local | 172.20.0.33 | — | — | — | — |
| nginx | nginx.4nk.local | 172.20.0.40 | 80 | conf:/etc/nginx, logs:/var/log/nginx | reverse proxy + /grafana/ | — |
### Observabilité
- Promtail lit: `./log/**/*.log`, `./modules/*/logs/**/*.log`, `./projects/*/*/logs/**/*.log` et pousse vers Loki.
- Grafana est servi via Nginx sous `/grafana/` et provisionné avec datasources/dashboards.
### Notes
- Les services internes utilisent des hostnames Docker `.4nk.local` résolus par le DNS du réseau `4nk_network`.
- Les tags d’images `:dev` sont en cours de création; voir `docs/CONFIGURATION.md`.

4
docs/USAGE.md
View File

@ -23,6 +23,7 @@
- Relais WebSocket: `ws://localhost/relay1/ws/` (idem `relay2`, `relay3`)
- Signer WS: `ws://localhost/signer/ws/`; HTTP: `http://localhost/signer/`
- Coffre front: `http://localhost/coffre/`
- Grafana: `http://localhost/grafana/`
## Commandes utiles
@ -35,4 +36,5 @@
- 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`
- Conf Tor: `modules/tor/conf/tor.conf` est montée si l'image Tor supporte `/etc/tor/torrc`
- Le reverse proxy Nginx s’appuie sur les hostnames Docker (`*.4nk.local`); en cas de changement d’IP/hostnames, mettre à jour `docker-compose.yml` et relancer `nginx`.