Ajouter cookcli/README.md
This commit is contained in:
parent
720545e2e1
commit
514bec8a49
42
cookcli/README.md
Normal file
42
cookcli/README.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
# CookCLI Server Add-on pour Home Assistant
|
||||||
|
|
||||||
|
Serveur CookCLI avec synchronisation Git automatique pour gérer vos recettes Cooklang.
|
||||||
|
|
||||||
|
## 🚀 Fonctionnalités
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
1. Ajoutez ce dépôt en tant que dépôt d'add-ons dans Home Assistant
|
||||||
|
2. Installez l'add-on "CookCLI Server"
|
||||||
|
3. Configurez les options (dépôt Git, intervalle de sync, etc.)
|
||||||
|
4. Démarrez l'add-on
|
||||||
|
|
||||||
|
## ⚙️ 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
|
||||||
|
recipes_path: /config/recipes
|
||||||
|
port: 9080
|
||||||
|
log_level: info
|
||||||
|
git_repository: https://github.com/mon-user/mes-recettes.git
|
||||||
|
git_branch: main
|
||||||
|
git_sync_interval: 3600
|
||||||
|
git_username: mon-user
|
||||||
|
git_password: mon-token-github
|
||||||
Loading…
Reference in a new issue