Ajout des README.md pour le dépôt et Heimdall

This commit is contained in:
2025-01-01 11:30:33 +01:00
parent c52f60fca9
commit 3eb81b5789
2 changed files with 65 additions and 1 deletions

View File

@@ -1,2 +1,40 @@
# docker-configs # Docker Configurations for Self-Hosted Applications
Ce dépôt contient les fichiers de configuration nécessaires pour déployer et gérer des applications auto-hébergées à l'aide de Docker et Docker Compose. Chaque application a son propre dossier avec ses configurations, fichiers associés, et instructions d'utilisation.
## Structure du Dépôt
docker-configs/ ├
── heimdall/
├── docker-compose.yaml
│ ├── config/
│ │ └── (fichiers de configuration spécifiques à Heimdall)
│ ├── .env
│ ├── README.md
├── deploy.sh
└── README.md
### Description des éléments
- **[application]/** : Dossier contenant les fichiers spécifiques à une application (ex. : `heimdall`).
- `docker-compose.yaml` : Configuration Docker Compose pour lancer l'application.
- `config/` : Dossier contenant les fichiers de configuration personnalisés pour l'application.
- `.env` : Variables d'environnement spécifiques à l'application.
- `README.md` : Documentation détaillée pour l'installation et l'utilisation de l'application.
- **deploy.sh** : Script de déploiement permettant de choisir une application et de la lancer (en cours de développement).
- **README.md** : Ce fichier.
## Applications Disponibles
1. **Heimdall** : Tableau de bord pour centraliser vos applications auto-hébergées.
## Instructions Générales
1. Clonez le dépôt :
```bash
git clone http://10.0.0.20:3004/gil.soulier@gmail.com/docker-configs.git
cd docker-configs

26
heimdall/README.md Normal file
View File

@@ -0,0 +1,26 @@
---
### **README.md dans le dossier Heimdall**
Voici un exemple pour le fichier `heimdall/README.md` :
```markdown
# Heimdall
## Description
Heimdall est une application web permettant de créer un tableau de bord centralisé pour accéder à toutes vos applications auto-hébergées.
## Prérequis
- Docker et Docker Compose installés sur l'hôte.
- Port **8080** disponible sur votre serveur.
## Déploiement
1. Configurez le fichier `.env` selon vos besoins (utilisez l'exemple fourni).
2. Si nécessaire, ajoutez ou modifiez les fichiers dans le dossier `config/` pour personnaliser Heimdall.
3. Lancez la commande suivante pour déployer l'application :
```bash
docker-compose up -d