74 lines
2.4 KiB
Markdown
74 lines
2.4 KiB
Markdown
# Configuration SDK Relay
|
|
|
|
## Variables d'environnement
|
|
|
|
Le service `sdk_relay` peut être configuré via les variables d'environnement suivantes :
|
|
|
|
### Variables principales
|
|
|
|
- **`SDK_RELAY_WS_URL`** : URL WebSocket pour les tests (défaut: `ws://0.0.0.0:8090`)
|
|
- **`WS_BIND_URL`** : URL de binding WebSocket (override de la configuration, défaut: valeur de `ws_url`)
|
|
- **`HEALTH_PORT`** : Port du serveur de santé (défaut: `8091`)
|
|
- **`HEALTH_BIND_ADDRESS`** : Adresse de binding du serveur de santé (défaut: `0.0.0.0`)
|
|
- **`RUST_LOG`** : Niveau de logging (défaut: `INFO`)
|
|
|
|
### Configuration via fichier
|
|
|
|
Le service utilise un fichier de configuration (`sdk_relay.conf`) avec les paramètres suivants :
|
|
|
|
```ini
|
|
core_url="http://bitcoin:38332"
|
|
ws_url="0.0.0.0:8090"
|
|
wallet_name="default"
|
|
network="signet"
|
|
blindbit_url="http://blindbit-oracle:8000"
|
|
zmq_url="tcp://bitcoin:29000"
|
|
storage="https://dev4.4nkweb.com/storage"
|
|
data_dir="/home/bitcoin/.4nk"
|
|
bitcoin_data_dir="/home/bitcoin/.bitcoin"
|
|
bootstrap_url="wss://dev3.4nkweb.com/ws/"
|
|
bootstrap_faucet=true
|
|
RUST_LOG="INFO"
|
|
sp_address="tsp1qqgmwp9n5p9ujhq2j6cfqe4jpkyu70jh9rgj0pwt3ndezk2mrlvw6jqew8fhsulewzglfr7g2aa48wyj4n0r7yasa3fm666vda8984ke8tuaf9m89"
|
|
```
|
|
|
|
## Changements récents
|
|
|
|
### v0.1.3 - Configuration externalisée avancée
|
|
|
|
- **Ajout** : Variables d'environnement `WS_BIND_URL`, `HEALTH_PORT`, `HEALTH_BIND_ADDRESS`
|
|
- **Ajout** : Support de la variable d'environnement `SDK_RELAY_WS_URL` pour les tests
|
|
- **Modification** : Remplacement de `localhost` par `0.0.0.0` dans les tests WebSocket
|
|
- **Amélioration** : Configuration plus flexible pour les environnements Docker
|
|
- **Correction** : Résolution du problème de binding sur 127.0.0.1 au lieu de 0.0.0.0
|
|
|
|
### Tests
|
|
|
|
Les tests WebSocket utilisent maintenant `ws://0.0.0.0:8090` au lieu de `ws://localhost:8090` pour une meilleure compatibilité avec les environnements Docker.
|
|
|
|
## Configuration Docker
|
|
|
|
```yaml
|
|
environment:
|
|
- WS_BIND_URL=0.0.0.0:8090
|
|
- HEALTH_PORT=8091
|
|
- HEALTH_BIND_ADDRESS=0.0.0.0
|
|
- RUST_LOG=INFO
|
|
volumes:
|
|
- ./relay/sdk_relay.conf:/home/bitcoin/.conf:ro
|
|
```
|
|
|
|
## Endpoints
|
|
|
|
- **WebSocket** : `0.0.0.0:8090` - Communication WebSocket
|
|
- **Health** : `0.0.0.0:8091` - Vérification de santé
|
|
|
|
## Dépannage
|
|
|
|
### Problème de connexion WebSocket
|
|
|
|
Si le service n'écoute pas sur `0.0.0.0:8090`, vérifiez :
|
|
|
|
1. La configuration `ws_url` dans le fichier de configuration
|
|
2. Les variables d'environnement Docker
|
|
3. Les logs du service pour les erreurs de binding |