fix(README.md): update README with improved layout, tool descriptions and installation instructions, add configuration section, and improve usage instructions
The commit changes the README file to provide a more organized layout, detailed descriptions of the required tools, updated installation instructions using `mise`, and added a configuration section for setting environment variables. Additionally, the usage instructions have been improved by providing an interactive menu (`fzf`) that allows users to add or remove users from a group.
This commit is contained in:
parent
ea960e5320
commit
0c2fa6c671
2 changed files with 28 additions and 15 deletions
43
README.md
43
README.md
|
|
@ -1,32 +1,45 @@
|
||||||
# Manage OpenLDAP
|
<div align="center">
|
||||||
|
<img src="sources/logo.png" alt="Manage OpenLDAP Logo" width="220"/>
|
||||||
|
|
||||||
Script interactif en Bash pour gérer les utilisateurs OpenLDAP (ajout, suppression).
|
<h1>Manage OpenLDAP</h1>
|
||||||
|
<p><i>Script interactif en Bash pour gérer les utilisateurs OpenLDAP.</i></p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Prérequis
|
## Prérequis
|
||||||
|
|
||||||
- `bash`
|
| Outil | Description | Requis |
|
||||||
- `fzf` (sélecteur interactif)
|
|---------|------------------------------|-----------|
|
||||||
- `figlet` (génération de bannières)
|
| `bash` | Interpréteur de commandes | Oui |
|
||||||
- `lolcat` (couleurs arc-en-ciel)
|
| `fzf` | Sélecteur interactif | Oui |
|
||||||
- `mise` (gestion des outils, optionnel)
|
| `figlet`| Génération de bannières | Oui |
|
||||||
|
| `lolcat`| Couleurs arc-en-ciel | Oui |
|
||||||
|
| `mise` | Gestion des outils | Optionnel |
|
||||||
|
|
||||||
Installation rapide avec `mise` :
|
### Installation rapide
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mise install
|
mise install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Définissez les variables suivantes selon votre environnement :
|
||||||
|
|
||||||
|
| Variable | Exemple | Description |
|
||||||
|
|----------------|----------------------|-----------------------|
|
||||||
|
| `LDAP_SERVER` | `example.com` | Adresse du serveur |
|
||||||
|
| `LDAP_BASE_DN` | `dc=example,dc=com` | DN de base |
|
||||||
|
|
||||||
## Utilisation
|
## Utilisation
|
||||||
|
|
||||||
|
Lancez le script :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./main.sh
|
./main.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Variable
|
Un menu interactif (`fzf`) s'affiche et permet de :
|
||||||
|
|
||||||
- LDAP_SERVER : exemple.com
|
1. **Ajouter** un ou plusieurs utilisateurs à un groupe
|
||||||
- LDAP_BASE_DN : dc=example,dc=com
|
|
||||||
|
|
||||||
Un menu interactif s'affiche via `fzf` permettant de :
|
|
||||||
1. Ajouter un nouvel utilisateur
|
|
||||||
2. Supprimer un utilisateur
|
|
||||||
|
|
|
||||||
BIN
sources/logo.png
Normal file
BIN
sources/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 791 KiB |
Loading…
Add table
Add a link
Reference in a new issue