Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions simple-dockstarter/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Generated files
docker-compose.yml
.env
config.yml

# Data directory
data/

# Python
__pycache__/
*.pyc
*.pyo
*.pyd
.Python
venv/
ENV/
env/

# IDE
.vscode/
.idea/
*.swp
*.swo
*~

# OS
.DS_Store
Thumbs.db
191 changes: 191 additions & 0 deletions simple-dockstarter/QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# Quick Start Guide 🚀

Schnellstart-Anleitung für Simple DockSTARTer in 5 Minuten.

## 1️⃣ Installation (2 Minuten)

```bash
# Navigiere zum Verzeichnis
cd ~/DockSTARTer/simple-dockstarter

# Führe Installations-Skript aus
./install.sh
```

Das Skript wird:
- ✅ System-Anforderungen prüfen
- ✅ Docker installieren (falls nicht vorhanden)
- ✅ Python-Abhängigkeiten installieren
- ✅ Setup durchführen

## 2️⃣ Erste Schritte (3 Minuten)

### Simple DockSTARTer starten

```bash
./dockstarter.py
# oder (wenn global installiert):
simple-ds
```

### Im Menü:

**Schritt 1: Apps auswählen**
```
📦 Select Apps
→ Wähle deine Apps mit [Leertaste]
→ Bestätige mit [Enter]
```

Beispiel-Setup für Media Server:
- [x] Jellyfin (Media Server)
- [x] Sonarr (TV Shows)
- [x] Radarr (Movies)
- [x] Jackett (Indexer)
- [x] Transmission (Download)

**Schritt 2: Einstellungen (Optional)**
```
⚙️ Configure Settings
→ Timezone: Europe/Berlin
→ Data Dir: (Standard OK)
```

**Schritt 3: Generate docker-compose.yml**
```
🔨 Generate docker-compose.yml
→ Wartet bis "✓ Generated..."
```

**Schritt 4: Container starten**
```
🚀 Start Containers
→ Wartet bis alle Container laufen
```

## 3️⃣ Zugriff auf deine Apps

Nach dem Start sind deine Apps verfügbar:

| App | URL | Standard-Port |
|-----|-----|---------------|
| Jellyfin | http://localhost:8096 | 8096 |
| Sonarr | http://localhost:8989 | 8989 |
| Radarr | http://localhost:7878 | 7878 |
| Portainer | http://localhost:9000 | 9000 |
| Transmission | http://localhost:9091 | 9091 |
| Jackett | http://localhost:9117 | 9117 |
| Pi-hole | http://localhost:8053 | 8053 |
| Home Assistant | http://localhost:8123 | 8123 |
| Grafana | http://localhost:3000 | 3000 |
| Nextcloud | http://localhost:8081 | 8081 |

**Tipp:** Ersetze `localhost` mit deiner Server-IP wenn du von einem anderen Gerät zugreifst.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (typo): Präposition und Kommasetzung in deutschem Satz leicht anpassen

Vorschlag: „Ersetze localhost durch deine Server-IP, wenn du von einem anderen Gerät zugreifst.“

Suggested change
**Tipp:** Ersetze `localhost` mit deiner Server-IP wenn du von einem anderen Gerät zugreifst.
**Tipp:** Ersetze `localhost` durch deine Server-IP, wenn du von einem anderen Gerät zugreifst.


## 4️⃣ Häufige Befehle

```bash
# Container status prüfen
docker compose ps

# Logs anzeigen
docker compose logs -f

# Einzelne App-Logs
docker compose logs -f jellyfin

# Container neu starten
docker compose restart

# Container stoppen
docker compose down

# Updates holen
docker compose pull
docker compose up -d
```

## 5️⃣ Beispiel-Setups

### Media Server Setup
```
✓ Jellyfin (Media Server)
✓ Sonarr (TV Management)
✓ Radarr (Movie Management)
✓ Jackett (Indexer)
✓ Transmission (Downloader)
✓ Tautulli (Monitoring)
```

### Home Server Setup
```
✓ Portainer (Docker UI)
✓ Homer (Dashboard)
✓ Pi-hole (Ad Blocker)
✓ Nextcloud (Cloud Storage)
✓ Nginx (Reverse Proxy)
```

### Smart Home Setup
```
✓ Home Assistant (Smart Home)
✓ Grafana (Dashboards)
✓ Portainer (Management)
```

## 6️⃣ Nächste Schritte

1. **Apps konfigurieren**
- Öffne die Web-Interfaces
- Folge den Setup-Wizards

2. **Daten-Verzeichnisse anpassen**
- Bearbeite `config.yml`
- Ändere `data_dir` auf deine gewünschte Location

3. **Eigene Apps hinzufügen**
- Erstelle neue YAML in `apps/`
- Siehe README für Format

4. **Automatische Updates**
- Installiere Watchtower
- Container werden automatisch aktualisiert

## 🆘 Probleme?

### Port bereits belegt
```bash
# Port-Konflikt lösen
nano apps/app-name.yml
# Ändere Port z.B. "8096:8096" → "8097:8096"
```

### Container startet nicht
```bash
# Logs prüfen
docker compose logs app-name

# Neustart erzwingen
docker compose down
docker compose up -d
```

### Permissions Fehler
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): „Permissions Fehler“ als Zusammensetzung mit Bindestrich schreiben

Nutze hier z.B. „Permissions-Fehler“ oder konsequent deutsch „Berechtigungsfehler“.

Suggested change
### Permissions Fehler
### Berechtigungsfehler

```bash
# Prüfe PUID/PGID
cat .env | grep PUID

# Sollte deine User-ID sein:
id -u # Deine PUID
id -g # Deine PGID
```

## 📚 Mehr Infos

- **Vollständige Dokumentation:** [README.md](README.md)
- **Eigene Apps erstellen:** Siehe README → "Eigene Apps hinzufügen"
- **Docker Befehle:** [Docker Compose Docs](https://docs.docker.com/compose/)

---

**Happy Docking! 🐳**
Loading