Documentation mise à jour
This commit is contained in:
58
scripts/CONTRIBUTING.md
Normal file
58
scripts/CONTRIBUTING.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
# 🤝 Contribution au projet
|
||||||
|
|
||||||
|
Merci de votre intérêt pour ce projet ! Ce guide explique comment contribuer efficacement.
|
||||||
|
|
||||||
|
## 🚀 Comment contribuer ?
|
||||||
|
|
||||||
|
### 1️⃣ Forker et cloner le dépôt
|
||||||
|
|
||||||
|
1. Forkez le dépôt sur votre compte Git.
|
||||||
|
2. Clonez-le en local :
|
||||||
|
```bash
|
||||||
|
git clone https://git.abonnel.fr/cedricAbonnel/notes-techniques.git
|
||||||
|
cd notes-techniques
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2️⃣ Créer une branche
|
||||||
|
|
||||||
|
Avant de faire vos modifications, créez une nouvelle branche :
|
||||||
|
```bash
|
||||||
|
git checkout -b feature/nom-de-votre-feature
|
||||||
|
```
|
||||||
|
Remplacez `nom-de-votre-feature` par une description claire de votre ajout ou correction.
|
||||||
|
|
||||||
|
### 3️⃣ Développer et tester
|
||||||
|
|
||||||
|
- Assurez-vous que votre code respecte la structure existante.
|
||||||
|
- Testez vos scripts avant de proposer une modification.
|
||||||
|
- Documentez vos changements si nécessaire (ajout d'explication dans `README.md` ou `INSTALL.md`).
|
||||||
|
|
||||||
|
### 4️⃣ Soumettre une Pull Request (PR)
|
||||||
|
|
||||||
|
1. Ajoutez et validez vos changements :
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m "Ajout d'une fonctionnalité X"
|
||||||
|
```
|
||||||
|
2. Poussez votre branche :
|
||||||
|
```bash
|
||||||
|
git push origin feature/nom-de-votre-feature
|
||||||
|
```
|
||||||
|
3. Créez une Pull Request depuis l'interface Git en expliquant vos changements.
|
||||||
|
|
||||||
|
## 📌 Bonnes pratiques
|
||||||
|
|
||||||
|
- **Code clair et lisible** : Commentez si nécessaire.
|
||||||
|
- **Respect de la structure** : Gardez les fichiers organisés.
|
||||||
|
- **Petites PRs bien définies** : Une PR = une seule amélioration claire.
|
||||||
|
- **Discussions ouvertes** : N'hésitez pas à poser des questions ou à proposer des idées.
|
||||||
|
|
||||||
|
## 🛠 Signaler un problème
|
||||||
|
|
||||||
|
Si vous trouvez un bug ou avez une suggestion, ouvrez une issue avec :
|
||||||
|
- Une description claire du problème
|
||||||
|
- Les étapes pour le reproduire
|
||||||
|
- Le comportement attendu
|
||||||
|
|
||||||
|
Merci pour votre contribution ! 🚀
|
||||||
|
|
||||||
58
scripts/INSTALL.md
Normal file
58
scripts/INSTALL.md
Normal 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 ! 🚀
|
||||||
|
|
||||||
21
scripts/LICENCE
Normal file
21
scripts/LICENCE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 Cédric Abonnel / Cedrix
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1,38 +1,71 @@
|
|||||||
# 📥 Récupération des scripts depuis le dépôt Git
|
# 📌 Scripts d'installation et de configuration
|
||||||
|
|
||||||
Ce dépôt permet de télécharger uniquement les scripts nécessaires sans cloner l'intégralité du projet.
|
Ce répertoire regroupe plusieurs familles de scripts permettant l'installation et la configuration de différents services sur un serveur.
|
||||||
|
|
||||||
## 🚀 Installation et utilisation
|
## 📂 Structure du répertoire
|
||||||
|
|
||||||
### 1️⃣ Télécharger le script `fetch_scripts.sh`
|
Chaque sous-dossier contient une famille de scripts destinés à l'installation et à la configuration d'un service particulier :
|
||||||
Pour récupérer le script principal, utilisez la commande suivante :
|
|
||||||
|
|
||||||
|
- **`server-mail/`** : Scripts pour installer et configurer un serveur de messagerie.
|
||||||
|
- **`server-httpd/`** : Scripts pour installer et configurer un serveur web (HTTPD).
|
||||||
|
|
||||||
|
## ⚙️ Utilisation
|
||||||
|
|
||||||
|
### 1️⃣ Cloner le dépôt ou télécharger un dossier spécifique
|
||||||
|
Vous pouvez cloner tout le dépôt ou télécharger uniquement un dossier particulier :
|
||||||
|
|
||||||
|
```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 correspondant au service que vous souhaitez installer, ou utilisez le script de déploiement ci-dessous.
|
||||||
|
|
||||||
|
### 2️⃣ Exécuter le script principal du service choisi
|
||||||
|
|
||||||
|
Exemple pour un serveur mail :
|
||||||
|
```bash
|
||||||
|
cd scripts/server-mail
|
||||||
|
./setup_server.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Script de déploiement automatisé
|
||||||
|
Ce dépôt propose un script permettant de télécharger uniquement les fichiers nécessaires sans cloner l'intégralité du projet.
|
||||||
|
|
||||||
|
### 🔹 1. Télécharger le script `fetch_scripts.sh`
|
||||||
|
Utilisez la commande suivante :
|
||||||
```bash
|
```bash
|
||||||
wget -O fetch_scripts.sh "https://git.abonnel.fr/cedricAbonnel/notes-techniques/raw/branch/main/scripts/fetch_scripts.sh"
|
wget -O fetch_scripts.sh "https://git.abonnel.fr/cedricAbonnel/notes-techniques/raw/branch/main/scripts/fetch_scripts.sh"
|
||||||
chmod +x fetch_scripts.sh
|
chmod +x fetch_scripts.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2️⃣ Exécuter le script
|
### 🔹 2. Exécuter le script
|
||||||
Lancez le script pour récupérer les fichiers nécessaires :
|
Lancez le script pour récupérer les fichiers nécessaires :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./fetch_scripts.sh
|
./fetch_scripts.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
Le script vous proposera une liste de dossiers disponibles. Sélectionnez ceux que vous souhaitez télécharger en entrant leurs numéros.
|
Le script vous proposera une liste de dossiers disponibles. Sélectionnez ceux que vous souhaitez télécharger en entrant leurs numéros.
|
||||||
|
|
||||||
### 3️⃣ Exemples d'utilisation
|
### 🔹 3. Exemple d'utilisation
|
||||||
#### 🔹 Exemple de sélection
|
#### 📌 Interface de sélection
|
||||||
```
|
```
|
||||||
📂 Sélectionnez les dossiers à télécharger (séparez par un espace) :
|
Sélectionnez les dossiers à télécharger :
|
||||||
[0] server-mail
|
[ ] server-mail
|
||||||
[1] server-httpd
|
[ ] server-httpd
|
||||||
[2] common
|
|
||||||
Entrez les numéros correspondants : 0 2
|
|
||||||
```
|
|
||||||
Cela téléchargera uniquement les fichiers des dossiers `server-mail` et `common`.
|
|
||||||
|
|
||||||
|
<Ok> <Annuler>
|
||||||
|
```
|
||||||
|
Seuls les dossiers cochés seront téléchargés.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
© 2025 - ProjetInterne by Cédrix.
|
## 🤝 Contribution
|
||||||
|
|
||||||
|
Vous pouvez ajouter de nouveaux scripts en respectant la structure existante et en documentant leur fonctionnement.
|
||||||
|
|
||||||
|
## 📜 Licence
|
||||||
|
|
||||||
|
Ce projet est sous licence [MIT](LICENSE).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user