Documentation mise à jour

This commit is contained in:
2025-03-10 07:58:10 +01:00
parent ff61441355
commit 46ab7a92c9
4 changed files with 188 additions and 18 deletions

58
scripts/INSTALL.md Normal file
View File

@@ -0,0 +1,58 @@
# 📥 Installation des scripts
Ce guide vous explique comment télécharger et exécuter les scripts d'installation et de configuration disponibles dans ce dépôt.
## 🛠 Prérequis
Avant d'utiliser les scripts, assurez-vous d'avoir :
- Un système Linux Debian like
- `git` installé sur votre machine si vous déployez avec GIT
- Les droits administrateur (`sudo`)
## 🚀 Installation
### 1⃣ Cloner le dépôt
Si vous souhaitez récupérer l'intégralité du projet, utilisez :
```bash
git clone https://git.abonnel.fr/cedricAbonnel/notes-techniques.git
cd notes-techniques/scripts
```
### 2⃣ Télécharger uniquement un dossier spécifique
Si vous ne souhaitez pas cloner tout le projet, utilisez Git sparse checkout :
```bash
git clone --depth 1 --filter=blob:none --sparse https://git.abonnel.fr/cedricAbonnel/notes-techniques.git
cd notes-techniques
git sparse-checkout add scripts/server-mail
```
Remplacez `server-mail` par le dossier du service que vous souhaitez installer.
### 3⃣ Exécuter un script d'installation
Une fois dans le bon dossier, lancez le script d'installation correspondant. Par exemple, pour installer un serveur de messagerie :
```bash
cd scripts/server-mail
./setup_server.sh
```
Suivez ensuite les instructions affichées.
## 📌 Utilisation du script de téléchargement automatique
Si vous préférez récupérer uniquement les fichiers nécessaires sans passer par Git, vous pouvez utiliser le script de téléchargement automatique :
### 1⃣ Télécharger le script
```bash
wget -O fetch_scripts.sh "https://git.abonnel.fr/cedricAbonnel/notes-techniques/raw/branch/main/scripts/fetch_scripts.sh"
chmod +x fetch_scripts.sh
```
### 2⃣ Exécuter le script
```bash
./fetch_scripts.sh
```
Le script vous proposera une liste de dossiers. Sélectionnez ceux que vous souhaitez télécharger.
## 📖 Support & Contribution
Si vous rencontrez un problème ou souhaitez proposer une amélioration, consultez le fichier `CONTRIBUTING.md` ou ouvrez une issue sur le dépôt.
Bonne installation ! 🚀