diff --git a/scripts/CONTRIBUTING.md b/scripts/CONTRIBUTING.md new file mode 100644 index 0000000..ee09834 --- /dev/null +++ b/scripts/CONTRIBUTING.md @@ -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 ! 🚀 + diff --git a/scripts/INSTALL.md b/scripts/INSTALL.md new file mode 100644 index 0000000..b18c224 --- /dev/null +++ b/scripts/INSTALL.md @@ -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 ! 🚀 + diff --git a/scripts/LICENCE b/scripts/LICENCE new file mode 100644 index 0000000..5f31909 --- /dev/null +++ b/scripts/LICENCE @@ -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. diff --git a/scripts/README.md b/scripts/README.md index 514c04d..873b470 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -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` -Pour rĂ©cupĂ©rer le script principal, utilisez la commande suivante : +Chaque sous-dossier contient une famille de scripts destinĂ©s Ă  l'installation et Ă  la configuration d'un service particulier : +- **`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 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 +### đŸ”č 2. ExĂ©cuter le script Lancez le script pour rĂ©cupĂ©rer les fichiers nĂ©cessaires : - ```bash ./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. -### 3ïžâƒŁ Exemples d'utilisation -#### đŸ”č Exemple de sĂ©lection +### đŸ”č 3. Exemple d'utilisation +#### 📌 Interface de sĂ©lection ``` -📂 SĂ©lectionnez les dossiers Ă  tĂ©lĂ©charger (sĂ©parez par un espace) : -[0] server-mail -[1] server-httpd -[2] common -Entrez les numĂ©ros correspondants : 0 2 -``` -Cela tĂ©lĂ©chargera uniquement les fichiers des dossiers `server-mail` et `common`. +SĂ©lectionnez les dossiers Ă  tĂ©lĂ©charger : +[ ] server-mail +[ ] server-httpd + +``` +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). +