davidtoribioeu/netbox-docker
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox-docker.git synced 2026-03-22 08:16:54 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README-INSTALL with detailed instructions for Portainer setup and NetBox plugins

Browse source
This commit is contained in:
bboerni2 2025-09-23 13:45:38 +02:00
parent 2f9575f293
commit 027be884e4
1 changed files with 38 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README-INSTALL.md
View file

@ -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 ## 1) Portainer: Repository-Stack vorbereiten
**Portainer UI → Stacks → Add stack → Repository** **Portainer UI → Stacks → Add stack → Repository**
* **Git repository**: User forked `netbox-docker` Repository - **Git repository**: Unser geforktes `netbox-docker` Repository eintragen.
* **Repository reference**: main branch - **Repository reference**: Branch wählen (z. B. `main`).
* **Compose path**: `docker-compose.yml` - **Compose path**: `docker-compose.yml`
* **Enable relative path volumes**: aktivieren. - **Enable relative path volumes**: aktivieren.
* **Base path**: `/var/docker` als relative path setzen. - **Base path**: `/var/docker` als relative path setzen.
--- ---
## 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
```