Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
152 lines (108 loc) · 3.86 KB

DEPLOYMENT.md

File metadata and controls

152 lines (108 loc) · 3.86 KB

Déploiement et Publication

📦 Source du Projet

Ce projet est une version internalisée dérivée de fligneul/aps2mqtt avec des améliorations et corrections spécifiques.

Différences avec l'original

  • ✅ Fix affichage firmware (Unknown → version réelle)
  • ✅ Fix crash onduleurs offline (protection NoneType)
  • ✅ Simplification config timezone (TZ uniquement)
  • ✅ Support Python 3.13
  • ✅ Dépendances mises à jour (pandas 2.2.3)
  • ✅ Nettoyage code et documentation

🐳 Image Docker

Image disponible sur DockerHub :

# Pull depuis DockerHub
docker pull mathilde25/aps2mqtt:v2.1.0
# ou version latest
docker pull mathilde25/aps2mqtt:latest

Build local (optionnel)

cd /app/homeassistant/aps2mqtt

# Build l'image localement
docker build -t aps2mqtt:v2.1.0 .

🚀 Déploiement Local

Option 1: Container Simple (Recommandé)

docker run -d \
  --name aps2mqtt \
  --restart unless-stopped \
  --network host \
  -e TZ=Europe/Paris \
  -e DEBUG=False \
  -e APS_ECU_IP=192.168.105.161 \
  -e APS_ECU_AUTO_RESTART=True \
  -e APS_ECU_STOP_AT_NIGHT=True \
  -e APS_ECU_POSITION_LAT=47.206 \
  -e APS_ECU_POSITION_LNG=-1.5645 \
  -e APS_ECU_WIFI_SSID=ECU \
  -e APS_ECU_WIFI_PASSWD=88888888 \
  -e MQTT_BROKER_HOST=192.168.105.46 \
  -e MQTT_BROKER_PORT=1883 \
  -e MQTT_BROKER_USER=king \
  -e MQTT_BROKER_PASSWD=qtnh70hy \
  -e MQTT_TOPIC_PREFIX=aps2mqtt \
  -v /app/homeassistant/aps2mqtt/data:/data \
  aps2mqtt:v2.1.0

Option 2: Docker Compose

Utilisez le fichier docker-compose.yml du repo avec vos paramètres personnels.

Note: Ce fichier contient des données sensibles et NE DOIT PAS être commité dans git.

Option 3: Docker Swarm

Non recommandé car nécessite un registry accessible par tous les nœuds du swarm.

📊 Vérification

# Logs du container
docker logs aps2mqtt

# Vérification MQTT
mosquitto_sub -h 192.168.105.46 -u king -P qtnh70hy -t "aps2mqtt/#" -v

# Statut dans Home Assistant
# Aller dans Paramètres > Appareils et Services > MQTT
# Vérifier les entités aps2mqtt

🔧 Mise à Jour

# Arrêter l'ancien container
docker stop aps2mqtt
docker rm aps2mqtt

# Rebuild avec les dernières modifications
docker build -t aps2mqtt:v2.1.0 .

# Redémarrer avec la nouvelle image
# Utiliser la commande docker run ci-dessus

📝 Gestion des Versions

Le projet utilise des tags git pour les versions :

# Lister les versions
git tag -l

# Créer une nouvelle version
git tag -a v2.1.1 -m "Description des changements"

# Voir les détails d'une version
git show v2.1.0

🔒 Sécurité

Données Sensibles

Les fichiers suivants contiennent des données sensibles et sont exclus du git (.gitignore) :

  • docker-compose.yaml (avec credentials)
  • ecu_id (ID de votre ECU)
  • data/ (données runtime)
  • LIMITATIONS.md (tests personnels)
  • .env (variables d'environnement)

Recommandations

  1. Ne jamais commiter de fichiers avec IPs, passwords, ou coordonnées GPS
  2. Utiliser des variables d'environnement pour les secrets
  3. Sauvegarder séparément vos configurations personnelles
  4. Utiliser un registry privé pour les images Docker avec données sensibles

📚 Documentation

🤝 Contribution

Ce projet est une version interne. Pour contribuer au projet original, visitez : https://github.com/fligneul/aps2mqtt

📧 Support

Pour ce déploiement spécifique, contacter l'équipe interne.

Pour le projet original, voir les issues GitHub de fligneul/aps2mqtt.