Actualiser cookcli/README.md
This commit is contained in:
parent
2093cb359d
commit
c61724f9eb
|
|
@ -1,42 +1,32 @@
|
||||||
# CookCLI Server Add-on pour Home Assistant
|
# CookCLI Server Add-on
|
||||||
|
|
||||||
Serveur CookCLI avec synchronisation Git automatique pour gérer vos recettes Cooklang.
|

|
||||||
|
[](LICENSE)
|
||||||
|
|
||||||
## 🚀 Fonctionnalités
|
Serveur CookCLI avec synchronisation Git automatique
|
||||||
|
|
||||||
- Serveur CookCLI prêt à l'emploi
|
---
|
||||||
- Synchronisation Git automatique des recettes
|
|
||||||
- Interface accessible via le port 9080
|
|
||||||
- Intégration avec l'API CookCLI pour Home Assistant
|
|
||||||
|
|
||||||
## 📦 Installation
|
## 🚀 Installation rapide
|
||||||
|
|
||||||
1. Ajoutez ce dépôt en tant que dépôt d'add-ons dans Home Assistant
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgit.thethomaas.net%2FTheThomaas%2Fhome-assistant-apps)
|
||||||
2. Installez l'add-on "CookCLI Server"
|
|
||||||
3. Configurez les options (dépôt Git, intervalle de sync, etc.)
|
1. **Ajoutez le dépôt** dans Supervisor → Add-ons → Dépôts :
|
||||||
4. Démarrez l'add-on
|
```
|
||||||
|
https://git.thethomaas.net/TheThomaas/home-assistant-apps
|
||||||
|
```
|
||||||
|
2. **Installez** l'add-on "CookCLI Server".
|
||||||
|
3. **Configurez** (au minimum `git_repository`).
|
||||||
|
4. **Démarrez** l'add-on.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## ⚙️ Configuration
|
## ⚙️ Configuration
|
||||||
|
|
||||||
### Options disponibles
|
|
||||||
|
|
||||||
- `recipes_path` : Dossier où stocker les recettes (défaut: `/config/recipes`)
|
|
||||||
- `port` : Port du serveur (défaut: 9080)
|
|
||||||
- `log_level` : Niveau de log (debug, info, warning, error)
|
|
||||||
- `git_repository` : URL du dépôt Git (ex: https://github.com/user/recipes.git)
|
|
||||||
- `git_branch` : Branche à utiliser (défaut: main)
|
|
||||||
- `git_sync_interval` : Intervalle de synchronisation en secondes (défaut: 3600)
|
|
||||||
- `git_username` : Nom d'utilisateur pour l'authentification (optionnel)
|
|
||||||
- `git_password` : Mot de passe ou token (optionnel)
|
|
||||||
|
|
||||||
### Exemple avec dépôt Git
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
recipes_path: /config/recipes
|
git_repository: https://github.com/user/recipes.git # Obligatoire
|
||||||
port: 9080
|
|
||||||
log_level: info
|
|
||||||
git_repository: https://github.com/mon-user/mes-recettes.git
|
|
||||||
git_branch: main
|
git_branch: main
|
||||||
git_sync_interval: 3600
|
git_sync_interval: 3600
|
||||||
git_username: mon-user
|
git_username: "" # Pour dépôt privé
|
||||||
git_password: mon-token-github
|
git_password: "" # Token ou mot de passe
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue