4nk/anchorage_layer_simple
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
anchorage_layer_simple/docs/README.md
ncantu 26a53327a4 Enhance: Complete dashboard documentation and new services integration 
**Motivations:**
- Complete documentation for dashboard, domains, ports and environment configuration
- Add new services (ClamAV API, Watermark API) to the infrastructure
- Enhance dashboard with new pages and improved functionality
- Improve deployment scripts and service configurations

**Root causes:**
- Missing comprehensive documentation for infrastructure setup
- Need for antivirus scanning service integration
- Need for watermark service integration
- Dashboard required additional pages and features

**Correctifs:**
- Added comprehensive documentation in docs/ (DASHBOARD.md, DOMAINS_AND_PORTS.md, ENVIRONMENT.md)
- Updated systemd service files with proper environment variables
- Enhanced nginx proxy configuration script
- Updated maintenance documentation

**Evolutions:**
- Added new ClamAV API service (api-clamav) for file scanning
- Added new Watermark API service (api-filigrane) for document watermarking
- Enhanced signet-dashboard with new learn.html page
- Improved dashboard UI with better styles and navigation
- Enhanced app.js with new functionality and better error handling
- Updated API documentation page with complete endpoint descriptions
- Added deployment scripts for watermark and nginx configuration
- Updated hash and UTXO lists with latest data
- Enhanced server.js with new routes and improved Bitcoin RPC integration

**Pages affectées:**
- docs/DASHBOARD.md: New comprehensive dashboard documentation
- docs/DOMAINS_AND_PORTS.md: New infrastructure domains and ports documentation
- docs/ENVIRONMENT.md: New environment variables documentation
- docs/MAINTENANCE.md: Updated maintenance procedures
- docs/README.md: Updated main documentation
- signet-dashboard/public/app.js: Enhanced with new features
- signet-dashboard/public/styles.css: Improved styling
- signet-dashboard/public/index.html: Enhanced main page
- signet-dashboard/public/learn.html: New educational page
- signet-dashboard/public/api-docs.html: Enhanced API documentation
- signet-dashboard/public/hash-list.html: Updated hash list page
- signet-dashboard/public/utxo-list.html: Updated UTXO list page
- signet-dashboard/public/join-signet.html: Updated join signet page
- signet-dashboard/src/server.js: Enhanced server with new routes
- signet-dashboard/start.sh: Updated startup script
- signet-dashboard/signet-dashboard.service: Updated systemd service
- api-anchorage/anchorage-api.service: Updated systemd service
- api-faucet/faucet-api.service: Updated systemd service
- configure-nginx-proxy.sh: Enhanced nginx configuration script
- add-watermark-certificate.sh: New watermark certificate script
- deploy-watermark-nginx.sh: New deployment script
- api-clamav/: New ClamAV API service
- api-filigrane/: New Watermark API service
- hash_list.txt, utxo_list.txt: Updated with latest data
- anchor_count.txt: Updated anchor count
2026-01-25 17:43:05 +01:00

2.9 KiB
Raw Blame History

Documentation Bitcoin Signet Custom

Ce dossier contient toute la documentation nécessaire pour la maintenance et l'utilisation du Bitcoin Signet custom.

Fichiers de Documentation

  • MAINTENANCE.md : Documentation complète de maintenance

    • Architecture et structure
    • Configuration et variables d'environnement
    • Commandes de maintenance
    • Gestion du conteneur
    • Mining
    • Accès RPC et API
    • Mise à jour
    • Dépannage
    • Sauvegarde et restauration

  • INSTALLATION_NEW_NODE.md : Guide d'installation d'un nouveau nœud

    • Installation initiale
    • Configuration pour rejoindre une chaîne existante
    • Configuration du mining
    • Vérification et dépannage
    • Partage d'informations avec d'autres nœuds

  • INTERFACES.md : Documentation des interfaces disponibles

    • API REST d'ancrage
    • Interface RPC Bitcoin Core
    • Interface ligne de commande (CLI)
    • Interface ZMQ (ZeroMQ)
    • Interface Docker
    • Interface de configuration
    • Interface de logs

  • MEMPOOL.md : Documentation de Mempool (explorateur blockchain)

    • Installation et configuration
    • Architecture et services
    • Utilisation et maintenance
    • Dépannage
    • Intégration avec l'infrastructure

  • DOMAINS_AND_PORTS.md : Documentation des domaines et ports

    • Liste complète des domaines et services
    • Ports fixes de toutes les APIs
    • Configuration Nginx et routage
    • Services systemd
    • Architecture réseau
    • Certificats SSL/TLS

  • ENVIRONMENT.md : Documentation des fichiers d'environnement

    • Variables d'environnement de tous les services
    • Fichiers .env et leur utilisation
    • Configuration des services systemd
    • Ordre de priorité des variables
    • Sécurité et bonnes pratiques

  • DASHBOARD.md : Documentation du Dashboard

    • Pages disponibles et fonctionnalités
    • Navigation et structure
    • Mise à jour automatique
    • API endpoints utilisés
    • Maintenance et dépannage

Démarrage Rapide

Installation

cd /home/ncantu/Bureau/code/bitcoin
sudo docker build -t bitcoin-signet .
sudo docker run --env-file .env -d --name bitcoin-signet-instance \
  -p 38332:38332 -p 38333:38333 -p 28332:28332 -p 28333:28333 -p 28334:28334 \
  bitcoin-signet

Vérification

sudo docker exec bitcoin-signet-instance bitcoin-cli -datadir=/root/.bitcoin getblockchaininfo

Logs

sudo docker logs -f bitcoin-signet-instance

Informations Importantes

  • Ports : RPC (38332), P2P (38333), ZMQ (28332-28334)
  • Configuration : Fichier .env à la racine du projet
  • Données : Stockées dans /root/.bitcoin/ dans le conteneur
  • Clés : Générées automatiquement, stockées dans .env et /root/.bitcoin/PRIVKEY.txt

Pour plus de détails, consultez MAINTENANCE.md.