NetBox: Netzwerkdokumentation schnell mit Docker installiert – Dein HowTo
Hey du! Hast du es satt, den Überblick über dein Netzwerk zu verlieren? Kabelsalat, unbekannte IP-Adressen und undokumentierte Geräte rauben dir den letzten Nerv? Dann bist du hier genau richtig! Wir zeigen dir, wie du mit NetBox, Docker und Docker Compose eine professionelle Netzwerkdokumentation aufziehst, die sich sehen lassen kann. Und das Beste: Es ist einfacher, als du denkst!
NetBox ist eine Open-Source-Software, die speziell für die Dokumentation von Netzwerken und IT-Infrastruktur entwickelt wurde. Stell es dir wie eine zentrale Datenbank für alles vor, was in deinem Netzwerk kreucht und fleucht: Geräte, IP-Adressen, VLANs, Kabelverbindungen, Racks, Standorte und vieles mehr. Und warum Docker? Weil Docker es dir unglaublich leicht macht, komplexe Anwendungen wie NetBox in Containern zu verpacken und zu betreiben – ohne dass du dich mit Abhängigkeiten und Konfigurations-Chaos herumschlagen musst.
Was du in diesem HowTo lernst
In diesem ausführlichen HowTo nehmen wir dich an die Hand und führen dich Schritt für Schritt durch die Installation von NetBox mit Docker. Wir werden:
- Die Voraussetzungen für die Installation klären.
- Docker und Docker Compose installieren (falls du das nicht schon hast).
- Die NetBox Docker-Compose-Datei herunterladen und anpassen.
- NetBox mit Docker Compose starten.
- Die ersten Schritte in NetBox erklären, damit du sofort loslegen kannst.
- Tipps und Tricks für die Nutzung von Netbox geben.
Also, worauf wartest du noch? Lass uns loslegen und dein Netzwerk in Ordnung bringen!
Schritt 1: Die Voraussetzungen – Was du brauchst
Bevor wir mit der eigentlichen Installation loslegen, müssen wir sicherstellen, dass du alles hast, was du brauchst. Keine Sorge, es ist nicht viel:
- Ein Linux-System: NetBox läuft am besten auf einem Linux-Server. Du kannst eine virtuelle Maschine (z.B. mit VirtualBox oder VMware) oder einen dedizierten Server verwenden. Die meisten gängigen Distributionen wie Ubuntu, Debian, CentOS oder Fedora sind geeignet.
- Docker: Wir brauchen Docker, um NetBox in einem Container zu betreiben.
- Docker Compose: Docker Compose erleichtert uns die Arbeit, da wir damit mehrere Container gleichzeitig verwalten können (NetBox besteht aus mehreren Komponenten).
- Grundlegende Kenntnisse der Kommandozeile: Du solltest dich nicht scheuen, ein paar Befehle in das Terminal einzutippen. Aber keine Angst, wir erklären alles ganz genau!
- Etwas Zeit und Geduld: Nimm dir ein bisschen Zeit, um die Schritte in Ruhe durchzugehen. Es lohnt sich!
Wenn du Docker und Docker Compose noch nicht installiert hast, keine Panik! Wir zeigen dir im nächsten Schritt, wie das geht.
Schritt 2: Docker und Docker Compose installieren
Wenn du Docker und Docker Compose bereits installiert hast, kannst du diesen Schritt überspringen. Falls nicht, folge einfach diesen Anweisungen (wir gehen hier von einem Ubuntu/Debian-System aus, für andere Distributionen findest du Anleitungen auf der Docker-Website):
Docker installieren
Aktualisiere zuerst deine Paketlisten und installiere die notwendigen Abhängigkeiten:
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
Füge den offiziellen Docker GPG-Schlüssel hinzu:
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
Füge das Docker-Repository zu deinen Paketquellen hinzu:
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
Installiere Docker Engine:
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io
Überprüfe, ob Docker läuft:
sudo systemctl status docker
Du solltest eine Ausgabe sehen, die anzeigt, dass Docker aktiv (running) ist.
Docker Compose installieren
Installiere Docker Compose mit folgendem Befehl:
sudo curl -L "https://github.com/docker/compose/releases/download/v2.24.6/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
(Hinweis: Prüfe auf der Docker Compose GitHub-Seite, ob es eine neuere Version gibt und passe den Befehl gegebenenfalls an.)
Mache die Datei ausführbar:
sudo chmod +x /usr/local/bin/docker-compose
Überprüfe die Installation:
docker-compose --version
Super! Jetzt hast du Docker und Docker Compose installiert und bist bereit für den nächsten Schritt.
Schritt 3: Die NetBox Docker-Compose-Datei herunterladen und anpassen
Jetzt kommt der eigentliche Clou: Wir holen uns die docker-compose Datei für NetBox. Diese Datei beschreibt, wie die verschiedenen Container für NetBox (Webserver, Datenbank, usw.) konfiguriert und miteinander verbunden werden sollen.
Wir verwenden die offizielle docker-compose Datei aus dem NetBox-Docker Repository auf GitHub. Du kannst die Datei entweder direkt herunterladen oder das Repository klonen (wir empfehlen das Klonen, da du dann später leichter Updates einspielen kannst):
Klone das Repository (du brauchst Git dafür, falls du es nicht hast: `sudo apt install git`):
git clone -b release https://github.com/netbox-community/netbox-docker
Wechsle in das Verzeichnis:
cd netbox-docker
Kopiere die Beispiel-Konfigurationsdatei:
cp docker-compose.override.yml.example docker-compose.override.yml
Jetzt öffne die Datei `docker-compose.override.yml` mit einem Texteditor deiner Wahl (z.B. nano oder vim):
nano docker-compose.override.yml
In dieser Datei kannst du einige Einstellungen anpassen. Wichtig sind vor allem:
- `ALLOWED_HOSTS`: Hier musst du die IP-Adresse oder den Domainnamen deines Servers eintragen, unter dem NetBox erreichbar sein soll. Wenn du NetBox nur lokal auf deinem Rechner testen willst, kannst du hier `localhost` eintragen. Wenn du von anderen Geräten im Netzwerk darauf zugreifen willst, trage die IP-Adresse deines Servers ein (z.B. `192.168.1.100`). Du kannst auch einen Domainnamen eintragen, wenn du einen hast (z.B. `netbox.meinedomain.de`). Trenne mehrere Einträge mit Kommas: `ALLOWED_HOSTS=localhost,192.168.1.100,netbox.meinedomain.de`
- `POSTGRES_PASSWORD`: Das Passwort für die PostgreSQL-Datenbank. Ändere es in ein sicheres Passwort!
- `REDIS_PASSWORD`: Das Passwort für den Redis-Cache. Auch hier ein sicheres Passwort wählen!
- `SECRET_KEY`: Ein langer, zufälliger Schlüssel, der für die Sicherheit von NetBox wichtig ist. Du kannst einen neuen Schlüssel generieren, indem du in deinem Terminal folgenden Befehl ausführst:
python3 /opt/netbox/netbox/generate_secret_key.pyund den generierten Wert hier einfügst.
Speichere die Datei, nachdem du die Änderungen vorgenommen hast.
Schritt 4: NetBox mit Docker Compose starten
Jetzt sind wir bereit, NetBox zu starten! Wechsle zurück in das `netbox-docker`-Verzeichnis (falls du nicht mehr dort bist) und führe folgenden Befehl aus:
sudo docker-compose up -d
Dieser Befehl bewirkt Folgendes:
- `docker-compose up`: Startet die in der `docker-compose.yml` definierten Container.
- `-d`: Startet die Container im Hintergrund (detached mode), sodass du dein Terminal weiter nutzen kannst.
Docker Compose lädt jetzt die benötigten Images herunter und startet die Container. Das kann beim ersten Mal eine Weile dauern. Du kannst den Fortschritt mit folgendem Befehl beobachten:
sudo docker-compose logs -f
Wenn alles geklappt hat, solltest du NetBox in deinem Browser unter der IP-Adresse oder dem Domainnamen erreichen, den du in der `docker-compose.override.yml` angegeben hast (z.B. `http://localhost:8000` oder `http://192.168.1.100:8000`).
Die Standard-Anmeldedaten sind:
- Benutzername: `admin`
- Passwort: `admin`
Ändere das Passwort unbedingt sofort nach dem ersten Login!
Schritt 5: Erste Schritte in NetBox
Glückwunsch! Du hast NetBox erfolgreich installiert. Jetzt kannst du anfangen, dein Netzwerk zu dokumentieren. Hier ein paar Tipps für den Anfang:
- Sites (Standorte): Lege zuerst deine Standorte an (z.B. „Zuhause“, „Büro“, „Rechenzentrum“).
- Racks: Definiere deine Racks (Schränke), in denen deine Geräte untergebracht sind.
- Devices (Geräte): Füge deine Geräte hinzu (Server, Switches, Router, usw.). Du kannst jedem Gerät einen Namen, eine Rolle, einen Standort, ein Rack und viele weitere Informationen zuweisen.
- IP Addresses (IP-Adressen): Weise deinen Geräten IP-Adressen zu.
- Interfaces (Schnittstellen): Dokumentiere die Netzwerkschnittstellen deiner Geräte (z.B. eth0, eth1, GigabitEthernet0/0).
- Connections: Stelle Verbindungen zwischen Geräten her, indem du die Schnittstellen miteinander verbindest. Damit hast du auch gleich eine Dokumentation deiner Verkabelung.
- VRFs und VLANs: Verwalte deine virtuellen Routing-Instanzen (VRFs) und VLANs.
NetBox bietet eine umfangreiche API, mit der du viele Aufgaben automatisieren kannst. Schau dir die offizielle Dokumentation an, um mehr darüber zu erfahren. Eine Demo findest du unter Netbox Demo
Zusätzliche Tipps und Tricks
- Regelmäßige Backups: Sichere regelmässig deine Netbox Datenbank.
- Updates: Halte deine Netbox installation aktuell, um sicher zu gehen das du immer die aktuellsten Features hast und Sicherheitslücken geschlossen sind.
- Community: Nutze die Netbox Community. Bei Fragen oder Problemen gibt es immer hilfsbereite Leute.
Wir hoffen, dieses HowTo hat dir geholfen, NetBox mit Docker zu installieren. Jetzt hast du ein mächtiges Werkzeug zur Hand, um dein Netzwerk in den Griff zu bekommen. Viel Spaß beim Dokumentieren!