Files
docker_dashboard/README.md

106 lines
2.6 KiB
Markdown

# Docker Dashboard (Netbox Integration)
Ein modernes Dashboard zur Visualisierung von Docker-Containern und Inventar-Daten, integriert mit Netbox. Entwickelt mit Next.js, React und Tailwind CSS.
## 🚀 Features
- **Inventar-Übersicht**: Darstellung von Container-Informationen.
- **Netbox Integration**: Nahtlose Anbindung an die Netbox API.
- **Modernes UI**: Responsives Design dank Tailwind CSS v4.
- **Dockerized**: Einfaches Deployment via Docker.
## 🛠️ Technologien
- **Frontend**: [Next.js 16](https://nextjs.org/), [React 19](https://react.dev/)
- **Styling**: [Tailwind CSS 4](https://tailwindcss.com/), Lucide React Icons
- **Deployment**: Docker & Docker Compose
---
## 📦 Deployment & Betrieb
### 1. Docker Build & Run (Manuell)
Wenn du Docker Compose nicht nutzen möchtest, kannst du den Container auch manuell bauen und starten.
**Image bauen:**
```bash
docker build -t docker-dashboard-frontend ./frontend
```
**Container starten:**
(Ersetze die Platzhalter durch deine Netbox-Daten)
```bash
docker run -d \
-p 3000:3000 \
-e NETBOX_API_URL="https://deine-netbox-url.com" \
-e NETBOX_API_TOKEN="dein_api_token" \
-e APP_TITLE="Mein Docker Dashboard" \
--name docker-dashboard \
docker-dashboard-frontend
```
Das Dashboard ist anschließend unter `http://localhost:3000` erreichbar.
---
### 2. Updates einspielen (Workflow)
Wenn sich am Code im Git etwas geändert hat, gehe wie folgt vor, um die Anwendung zu aktualisieren:
**1. Code aktualisieren:**
```bash
git pull origin main
```
**2. Container neu bauen und starten (mit Docker Compose):**
```bash
docker-compose up -d --build
```
**ODER Manuell (ohne Compose):**
```bash
# Alten Container stoppen & löschen
docker stop docker-dashboard
docker rm docker-dashboard
# Image neu bauen
docker build -t docker-dashboard-frontend ./frontend
# Neu starten (siehe Befehl oben unter "Container starten")
```
---
## 🔧 Git-Verwaltung
Dieses Projekt wird unter `https://git.klenzel.net/Klenzel/docker_dashboard` verwaltet.
**Initiales Setup (falls noch nicht geschehen):**
```bash
git init
git remote add origin https://git.klenzel.net/Klenzel/docker_dashboard
git add .
git commit -m "Initial commit"
git push -u origin main
```
**Änderungen hochladen:**
```bash
git add .
git commit -m "Beschreibung der Änderung"
git push origin main
```
---
## 📂 Projektstruktur
- `docker-compose.yml`: Definition der Services.
- `frontend/`: Quellcode der Next.js Anwendung.
- `src/app/`: Next.js App Router Pages.
- `src/lib/`: Hilfsfunktionen und API-Clients.
- `src/components/`: UI-Komponenten.
```