-
-
Notifications
You must be signed in to change notification settings - Fork 289
Add Simple DockSTARTer - Simplified Python alternative #2313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
matdan1987
wants to merge
5
commits into
GhostWriters:main
Choose a base branch
from
matdan1987:claude/simplified-dockstarter-019FvyRBjSi92EZJsc1QypSz
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
40e46a0
Add Simple DockSTARTer - Simplified Python alternative
claude b6061ea
Update documentation for local usage
claude 67fef2c
Add download instructions and clarify distribution
claude 40288d7
Make Simple DockSTARTer completely standalone
claude 49222ec
Add README-STANDALONE clarifying separation from DockSTARTer
claude File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||||||
|
|
||||||
| ## 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 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
|
||||||
| ```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! 🐳** | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
localhostdurch deine Server-IP, wenn du von einem anderen Gerät zugreifst.“