Update README with Docker CLI instructions and workflow
This commit is contained in:
104
README.md
104
README.md
@@ -7,7 +7,7 @@ Ein modernes Dashboard zur Visualisierung von Docker-Containern und Inventar-Dat
|
||||
- **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 Compose.
|
||||
- **Dockerized**: Einfaches Deployment via Docker.
|
||||
|
||||
## 🛠️ Technologien
|
||||
|
||||
@@ -15,44 +15,86 @@ Ein modernes Dashboard zur Visualisierung von Docker-Containern und Inventar-Dat
|
||||
- **Styling**: [Tailwind CSS 4](https://tailwindcss.com/), Lucide React Icons
|
||||
- **Deployment**: Docker & Docker Compose
|
||||
|
||||
## 📦 Installation & Setup
|
||||
---
|
||||
|
||||
### Voraussetzungen
|
||||
## 📦 Deployment & Betrieb
|
||||
|
||||
- Docker & Docker Compose
|
||||
- Zugriff auf eine Netbox-Instanz (API URL & Token)
|
||||
### 1. Docker Build & Run (Manuell)
|
||||
|
||||
### Starten mit Docker Compose
|
||||
Wenn du Docker Compose nicht nutzen möchtest, kannst du den Container auch manuell bauen und starten.
|
||||
|
||||
1. **Repository klonen** (oder Dateien herunterladen).
|
||||
**Image bauen:**
|
||||
```bash
|
||||
docker build -t docker-dashboard-frontend ./frontend
|
||||
```
|
||||
|
||||
2. **Umgebungsvariablen konfigurieren**:
|
||||
Erstelle eine `.env` Datei im Hauptverzeichnis oder nutze die bestehende.
|
||||
|
||||
```env
|
||||
NETBOX_API_URL=https://deine-netbox-url.com
|
||||
NETBOX_API_TOKEN=dein_api_token
|
||||
APP_TITLE="Mein Docker Dashboard"
|
||||
```
|
||||
|
||||
3. **Container starten**:
|
||||
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
```
|
||||
|
||||
Das Dashboard ist nun unter `http://localhost:3000` erreichbar.
|
||||
|
||||
## 🔧 Entwicklung
|
||||
|
||||
Um das Frontend lokal ohne Docker zu entwickeln:
|
||||
**Container starten:**
|
||||
(Ersetze die Platzhalter durch deine Netbox-Daten)
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
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.
|
||||
@@ -60,3 +102,5 @@ npm run dev
|
||||
- `src/app/`: Next.js App Router Pages.
|
||||
- `src/lib/`: Hilfsfunktionen und API-Clients.
|
||||
- `src/components/`: UI-Komponenten.
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user