diff --git a/README.md b/README.md new file mode 100644 index 0000000..d421f43 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Portail Infra + +Portail d'outils pour administrateurs systèmes et réseau, servi par un serveur Python unique : + +- **cmdb** — inventaire (machines, réseaux, IP/MAC, salles & baies), recherche Active Directory, import/export CSV, snapshots de la base +- **cert-generator** — génération de certificats SSL (clés RSA, CSR) +- **switch-config** — mapper de VLAN et export de configuration switch + +Le tout accessible depuis un seul serveur, avec navigation entre les 3 apps. + +## Prérequis + +- [mise](https://mise.jdx.dev/) — lanceur de tâches +- [uv](https://docs.astral.sh/uv/) — gestion des dépendances et de Python + +`uv` installe automatiquement **Python 3.13** et les dépendances (`ldap3`) au premier lancement — rien d'autre à installer. + +Installer mise et uv : + +```bash +curl https://mise.run | sh # mise +curl -LsSf https://astral.sh/uv/install.sh | sh # uv +``` + +## Installation + +Le dossier `cmdb` est un sous-module git — cloner avec `--recurse-submodules` : + +```bash +git clone --recurse-submodules +cd VERSION2 +``` + +Sous-module déjà cloné sans l'option : + +```bash +git submodule update --init --recursive +``` + +## Lancer + +```bash +mise run run +``` + +Puis ouvrir **http://127.0.0.1:8000** (redirige vers la CMDB). + +Équivalent direct, sans mise : + +```bash +uv run server.py # port 8000 par défaut +uv run server.py 8080 # port personnalisé +``` + +## Notes + +- **Données** : la base `cmdb/cmdb.db` et le dossier `cmdb/snapshots/` restent **locaux** (non versionnés). Sauvegarde/migration via **Export CSV** ou **Snapshots** (Préférences ⚙). +- **Active Directory** : la recherche AD nécessite `ldap3` (installé par uv). Configuration dans Préférences → Active Directory. +- **Proxy d'entreprise** : si l'accès réseau passe par un proxy, exporter `http_proxy` / `https_proxy` avant de lancer.