# 📚 Index de Documentation - sdk_relay

Index complet de la documentation du service de relais sdk_relay pour les Silent Payments.

## 📖 Guides Principaux

### 🚀 [Guide d'Installation](INSTALLATION.md)
Guide complet pour installer et configurer le service sdk_relay.
- **Prérequis système et logiciels**
- **Installation Docker et Rust**
- **Configuration Bitcoin Core et Blindbit**
- **Tests post-installation**
- **Dépannage et monitoring**

### 📖 [Guide d'Utilisation](USAGE.md)
Guide complet pour utiliser le service sdk_relay au quotidien.
- **Démarrage du service**
- **Connexion WebSocket et HTTP**
- **Gestion des relais et synchronisation**
- **Monitoring et métriques**
- **Tests et validation**

### ⚙️ [Guide de Configuration](CONFIGURATION.md)
Guide complet pour configurer le service selon vos besoins.
- **Configuration générale et variables d'environnement**
- **Configuration Bitcoin Core RPC**
- **Configuration Blindbit Oracle**
- **Configuration réseau et sécurité**
- **Configuration Docker et production**

## 🔧 Guides Techniques

### 🏗️ [Architecture Technique](ARCHITECTURE.md)
Documentation technique détaillée de l'architecture.
- **Architecture générale du service**
- **Composants principaux (WebSocket, HTTP, RPC)**
- **Architecture de synchronisation mesh**
- **Flux de données entre services**
- **Sécurité et isolation**
- **Performance et optimisations**
- **Monitoring et observabilité**

### 📡 [API Reference](API.md)
Documentation complète des APIs disponibles.
- **API WebSocket** : Interface temps réel pour les clients
- **API HTTP REST** : API REST pour les opérations de gestion
- **API Bitcoin Core RPC** : Interface JSON-RPC pour Bitcoin
- **Format des messages et payloads**
- **Gestion des erreurs**
- **Exemples d'utilisation**
- **Limites et quotas**

### 🔒 [Sécurité](SECURITY.md)
Guide de sécurité et bonnes pratiques.
- **Authentification et autorisation**
- **Chiffrement et certificats**
- **Isolation réseau**
- **Audit et monitoring de sécurité**
- **Bonnes pratiques**

### 🐙 [Configuration Gitea](GITEA_SETUP.md)
Guide de configuration spécifique pour Gitea.
- **Configuration du repository Gitea**
- **Templates d'issues et pull requests**
- **Configuration CI/CD avec Gitea Actions**
- **Intégrations et webhooks**
- **Workflow de contribution**
- **Sécurité et permissions**

### 🚀 [Plan de Release](RELEASE_PLAN.md)
Plan de lancement open source complet.
- **Phases de préparation**
- **Communication et marketing**
- **Checklist de lancement**
- **Support communautaire**
- **Gestion des risques**

### 🌟 [Guide de la Communauté](COMMUNITY_GUIDE.md)
Guide complet pour la communauté.
- **Comment contribuer**
- **Ressources d'apprentissage**
- **Environnement de développement**
- **Processus de contribution**
- **Support et reconnaissance**

### 🗺️ [Roadmap](ROADMAP.md)
Roadmap de développement détaillée.
- **Timeline de développement**
- **Fonctionnalités planifiées**
- **Évolution de l'architecture**
- **Métriques de succès**

## 🧪 Guides de Test

### 🧪 [Guide des Tests](TESTING.md)
Guide complet pour les tests du service.
- **Tests unitaires Rust**
- **Tests d'intégration**
- **Tests de performance**
- **Tests de sécurité**
- **Tests de charge**
- **Tests de régression**

### 🔍 [Audit de Sécurité](SECURITY_AUDIT.md)
Audit de sécurité détaillé.
- **Vulnérabilités connues**
- **Tests de pénétration**
- **Audit de code**
- **Recommandations de sécurité**
- **Plan de remédiation**

## 🔧 Guides de Développement

### 🔧 [Guide de Développement](DEVELOPMENT.md)
Guide complet pour le développement.
- **Environnement de développement**
- **Workflow de développement**
- **Standards de code**
- **Debugging et profiling**
- **Optimisation des performances**
- **Déploiement et CI/CD**

### 📋 [Référence Rapide](QUICK_REFERENCE.md)
Référence rapide pour les développeurs.
- **Commandes essentielles**
- **Structure du projet**
- **APIs principales**
- **Configuration rapide**
- **Dépannage rapide**

### 🔄 [Guide de Migration](MIGRATION.md)
Guide pour les migrations et mises à jour.
- **Migration des versions**
- **Breaking changes**
- **Mise à jour des dépendances**
- **Migration des données**
- **Tests de migration**

## 🌐 Guides d'Intégration

### 🔗 [Intégration 4NK_node](INTEGRATION_4NK_NODE.md)
Guide d'intégration avec l'infrastructure 4NK_node.
- **Configuration Docker Compose**
- **Variables d'environnement**
- **Communication inter-services**
- **Déploiement intégré**
- **Monitoring et logs**

### 🔑 [Configuration SSH](SSH_SETUP.md)
Guide de configuration SSH pour le développement.
- **Génération des clés SSH**
- **Configuration Git**
- **Intégration avec Gitea**
- **Automatisation des déploiements**

### 🤖 [Push SSH Automatisé](AUTO_SSH_PUSH.md)
Guide pour l'automatisation des pushes SSH.
- **Configuration des scripts**
- **Intégration CI/CD**
- **Gestion des clés**
- **Sécurité et bonnes pratiques**

## 📊 État et Monitoring

### 📊 [État Actuel](ETAT_ACTUEL.md)
État détaillé du projet sdk_relay.
- **Statut des compilations**
- **Configuration des branches**
- **Fonctionnalités opérationnelles**
- **Métriques de performance**
- **Problèmes connus**

### 📋 [Résumé Final](RESUME_FINAL.md)
Résumé complet de l'état final du projet.
- **Succès accomplis**
- **Prêt pour la production**
- **Documentation complète**
- **Support et maintenance**

## 🔧 Guides d'Open Source

### ✅ [Checklist Open Source](OPEN_SOURCE_CHECKLIST.md)
Checklist complète pour l'ouverture en open source.
- **Préparation du code**
- **Documentation**
- **Licences et légal**
- **Infrastructure**
- **Communication**

## 📞 Support et Contact

### 📞 [Support](SUPPORT.md)
Guide de support et contact.
- **Comment obtenir de l'aide**
- **Création d'issues**
- **Canal de communication**
- **FAQ**
- **Ressources additionnelles**

## 🚨 Dépannage

### 🔧 [Guide de Dépannage](TROUBLESHOOTING.md)
Guide complet pour résoudre les problèmes.
- **Problèmes courants**
- **Diagnostic et logs**
- **Solutions étape par étape**
- **Contact support**

## 📈 Performance

### ⚡ [Guide de Performance](PERFORMANCE.md)
Guide pour optimiser les performances.
- **Métriques de performance**
- **Optimisations**
- **Benchmarks**
- **Monitoring**

## 📚 Exemples et Cas d'Usage

### 💡 [Exemples Pratiques](EXEMPLES_PRATIQUES.md)
Exemples concrets d'utilisation.
- **Cas d'usage typiques**
- **Exemples de code**
- **Intégrations**
- **Bonnes pratiques**

---

## 🎯 Navigation Rapide

### 🚀 Démarrage Rapide
1. [Installation](INSTALLATION.md) - Installer sdk_relay
2. [Configuration](CONFIGURATION.md) - Configurer l'environnement
3. [Utilisation](USAGE.md) - Utiliser le service

### 🔧 Développement
1. [Architecture](ARCHITECTURE.md) - Comprendre l'architecture
2. [API](API.md) - Consulter les APIs
3. [Tests](TESTING.md) - Exécuter les tests

### 📚 Documentation
1. [Index](INDEX.md) - Cet index
2. [Quick Reference](QUICK_REFERENCE.md) - Référence rapide
3. [Roadmap](ROADMAP.md) - Évolution du projet

### 🤝 Communauté
1. [Guide Communauté](COMMUNITY_GUIDE.md) - Contribuer
2. [Code de Conduite](../CODE_OF_CONDUCT.md) - Règles de conduite
3. [Support](SUPPORT.md) - Obtenir de l'aide

---

## 🧪 Tests et Validation

### Tests Automatisés
```bash
# Tests unitaires
cargo test --all

# Tests d'intégration
cargo test --test integration

# Tests de performance
cargo test --test performance

# Linting
cargo clippy -- -D warnings

# Formatage
cargo fmt -- --check
```

### Tests Manuels
```bash
# Vérification de santé
curl http://localhost:8091/health

# Test WebSocket
wscat -c ws://localhost:8090

# Test métriques
curl http://localhost:8091/metrics
```

---

## 🚀 Développement

### Commandes Essentielles
```bash
# Build de développement
cargo build

# Build de production
cargo build --release

# Exécution
cargo run -- --config .conf

# Docker
docker build -f Dockerfile .
docker run -p 8090:8090 -p 8091:8091 sdk_relay
```

---

**📚 Documentation complète pour sdk_relay - Service de relais pour les Silent Payments** 🚀