20d115a31c
**Motivations:** - Add API services for anchorage and faucet functionality - Add dashboard interface for signet monitoring - Improve documentation and maintenance guides - Enhance existing scripts for better functionality **Root causes:** - Need for API services to interact with Bitcoin Signet - Need for user-friendly dashboard interface - Need for comprehensive documentation - Scripts required improvements for better reliability **Correctifs:** - Updated Dockerfile with better configuration - Improved gen-bitcoind-conf.sh and gen-signet-keys.sh scripts - Enhanced mine.sh, miner, run.sh, and setup-signet.sh scripts - Updated env.example with new configuration options **Evolutions:** - Added api-anchorage service with anchor functionality - Added api-faucet service for testnet coin distribution - Added signet-dashboard for monitoring and management - Added comprehensive documentation in docs/ directory - Added configure-nginx-proxy.sh for proxy configuration - Added update-signet.sh for signet updates - Added ETAT_SYSTEME.md and START_DASHBOARD_AND_FAUCET.md guides - Added .bitcoin-version file for version tracking **Pages affectées:** - Dockerfile - env.example - gen-bitcoind-conf.sh - gen-signet-keys.sh - mine.sh - miner - run.sh - setup-signet.sh - api-anchorage/ (new) - api-faucet/ (new) - signet-dashboard/ (new) - docs/ (new) - configure-nginx-proxy.sh (new) - update-signet.sh (new) - ETAT_SYSTEME.md (new) - START_DASHBOARD_AND_FAUCET.md (new) - .bitcoin-version (new) - .env (modified) - mempool/ (added)
102 lines
1.7 KiB
Markdown
102 lines
1.7 KiB
Markdown
# Guide de Démarrage Rapide - Dashboard et API Faucet
|
|
|
|
## Vue d'ensemble
|
|
|
|
Deux nouveaux services ont été créés pour Bitcoin Signet :
|
|
|
|
1. **Dashboard de Supervision** (port 3020)
|
|
2. **API Faucet** (port 3021)
|
|
|
|
## Installation Rapide
|
|
|
|
### 1. Dashboard de Supervision
|
|
|
|
```bash
|
|
cd signet-dashboard
|
|
npm install
|
|
cp .env.example .env
|
|
# Éditer .env avec vos paramètres
|
|
npm start
|
|
```
|
|
|
|
### 2. API Faucet
|
|
|
|
```bash
|
|
cd api-faucet
|
|
npm install
|
|
cp .env.example .env
|
|
# Éditer .env avec vos paramètres
|
|
npm start
|
|
```
|
|
|
|
## Configuration Minimale
|
|
|
|
### Dashboard (.env)
|
|
|
|
```bash
|
|
BITCOIN_RPC_HOST=localhost
|
|
BITCOIN_RPC_PORT=38332
|
|
BITCOIN_RPC_USER=bitcoin
|
|
BITCOIN_RPC_PASSWORD=bitcoin
|
|
DASHBOARD_PORT=3020
|
|
ANCHOR_API_URL=http://localhost:3010
|
|
ANCHOR_API_KEY=your-api-key-here
|
|
FAUCET_API_URL=http://localhost:3021
|
|
```
|
|
|
|
### API Faucet (.env)
|
|
|
|
```bash
|
|
BITCOIN_RPC_HOST=localhost
|
|
BITCOIN_RPC_PORT=38332
|
|
BITCOIN_RPC_USER=bitcoin
|
|
BITCOIN_RPC_PASSWORD=bitcoin
|
|
FAUCET_API_PORT=3021
|
|
FAUCET_AMOUNT=0.0005
|
|
```
|
|
|
|
## Démarrage avec PM2 (Production)
|
|
|
|
### Dashboard
|
|
|
|
```bash
|
|
cd signet-dashboard
|
|
pm2 start src/server.js --name signet-dashboard
|
|
pm2 save
|
|
```
|
|
|
|
### API Faucet
|
|
|
|
```bash
|
|
cd api-faucet
|
|
pm2 start src/server.js --name faucet-api
|
|
pm2 save
|
|
```
|
|
|
|
## Accès
|
|
|
|
- **Dashboard** : http://localhost:3020
|
|
- **API Faucet Health** : http://localhost:3021/health
|
|
|
|
## Vérification
|
|
|
|
```bash
|
|
# Vérifier que les services sont actifs
|
|
pm2 status
|
|
|
|
# Vérifier les logs
|
|
pm2 logs signet-dashboard
|
|
pm2 logs faucet-api
|
|
|
|
# Tester le dashboard
|
|
curl http://localhost:3020/api/blockchain/info
|
|
|
|
# Tester l'API faucet
|
|
curl http://localhost:3021/health
|
|
```
|
|
|
|
## Documentation Complète
|
|
|
|
- Dashboard : `signet-dashboard/README.md`
|
|
- API Faucet : `api-faucet/README.md`
|