From 027be884e4407fe5cee735d53453f620287c2e73 Mon Sep 17 00:00:00 2001 From: bboerni2 <93215657+bboerni2@users.noreply.github.com> Date: Tue, 23 Sep 2025 13:45:38 +0200 Subject: [PATCH] Update README-INSTALL with detailed instructions for Portainer setup and NetBox plugins --- README-INSTALL.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README-INSTALL.md b/README-INSTALL.md index a43aa92..af96d22 100644 --- a/README-INSTALL.md +++ b/README-INSTALL.md @@ -1,15 +1,45 @@ -# README-INSTALL · NetBox-Docker on Portainer +# · NetBox-Docker on Portainer -> **Status:** Factory Reset durchgeführt – frischer Fork vom Original-Repo, Deployment neu gestartet. +> **Status:** User forked original netbox docker repository ## 1) Portainer: Repository-Stack vorbereiten **Portainer UI → Stacks → Add stack → Repository** -* **Git repository**: User forked `netbox-docker` Repository -* **Repository reference**: main branch -* **Compose path**: `docker-compose.yml` -* **Enable relative path volumes**: aktivieren. -* **Base path**: `/var/docker` als relative path setzen. +- **Git repository**: Unser geforktes `netbox-docker` Repository eintragen. +- **Repository reference**: Branch wählen (z. B. `main`). +- **Compose path**: `docker-compose.yml` +- **Enable relative path volumes**: aktivieren. +- **Base path**: `/var/docker` als relative path setzen. ---- \ No newline at end of file +--- + +## 2) NetBox-Plugins + +- `netbox-topology-views` – Interaktive L2/L3-Topologieansicht. +- `netbox-device-lifecycle-mgmt` – Lifecycle-/EoX-Verwaltung für Geräte. +- `netbox-plugin-prometheus-sd` – Service Discovery für Prometheus. +- `netbox-qrcode` – QR-Codes für Objekte (Inventar/Asset-Labels). + +### 2.1 Plugin-Installation mit netbox-docker +netbox-docker unterstützt eine separate **`requirements-plugins.txt`**, die beim Image-Build installiert wird. + +### 2.2 `requirements-plugins.txt` +```text +# Versions bewusst pinned +netbox-topology-views>=4.2.0,<5.0.0 +netbox-device-lifecycle-mgmt>=1.1.0,<2.0.0 +netbox-plugin-prometheus-sd>=0.3.0,<1.0.0 +netbox-qrcode>=0.0.17,<1.0.0 +``` + +## 3) Portainer Stack deploy + +### 3.1 Admin User erstellen + +Um einen ersten **Administrator-Account** (Superuser) anzulegen, kann der Befehl direkt im laufenden NetBox-Container ausgeführt werden. + +**Command (copy-fähig):** +```bash +docker compose exec netbox python3 /opt/netbox/netbox/manage.py createsuperuser +``` \ No newline at end of file