Add README.md
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Startseite Dashboard
|
||||
|
||||
Ein einfaches Dashboard-Projekt, das als Startseite dient.
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
* Docker
|
||||
* Docker Compose
|
||||
|
||||
## Installation & Start
|
||||
|
||||
1. **Repository klonen:**
|
||||
|
||||
```bash
|
||||
git clone http://git.klenzel.net/Klenzel/startseite.git
|
||||
cd startseite
|
||||
```
|
||||
|
||||
2. **Umgebungsvariablen konfigurieren:**
|
||||
|
||||
Kopiere die Beispiel-Konfigurationsdatei `.env.example` nach `.env` und passe die Werte an (Benutzername, Passwort, Secret Key).
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
nano .env
|
||||
```
|
||||
|
||||
> **Wichtig:** Ändere unbedingt `ADMIN_PASSWORD` und `SECRET_KEY`!
|
||||
|
||||
3. **Container starten:**
|
||||
|
||||
Starte den Container im Hintergrund:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Das Dashboard ist nun erreichbar (da `network_mode: "host"` verwendet wird, läuft es direkt auf dem Host-Port, standardmäßig meist Port 5000, siehe `app.py` für Details).
|
||||
|
||||
## Änderungen & Container neu bauen
|
||||
|
||||
Wenn du Änderungen am Code (z.B. in `app/`) oder an der Konfiguration vornimmst, muss der Container neu gebaut werden, damit diese wirksam werden.
|
||||
|
||||
Führe dazu folgenden Befehl aus:
|
||||
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
```
|
||||
|
||||
Dieser Befehl baut das Image neu und startet den Container anschließend neu, falls sich etwas geändert hat.
|
||||
|
||||
Alternativ in zwei Schritten:
|
||||
|
||||
```bash
|
||||
docker-compose build
|
||||
docker-compose up -d
|
||||
```
|
||||
Reference in New Issue
Block a user