Schön, dass du hier bist! Wähle ein Repository aus, um freundliche Einblicke in die Projekte von rinkelzz zu erhalten.
Repository: rinkelzz/cockpit
Synology-DSM-Paket: ntfy-Push-Nachrichten empfangen und GitHub-Issues deiner Repos ansehen, kommentieren, schließen und mit Labels versehen – jeder Benutzer mit eigenem Cockpit.
⬇️ ZIP herunterladen
Branch: main
Owner
rinkelzz
Betreibe Lapalutschi.de — Tutorials zu Proxmox, Homelab, Linux & lokaler KI. Self-Hoster, Container-Stack, Linux-Workflow im Detail.
README
# Cockpit für Synology
[](https://buymeacoffee.com/lapalutschi)
[](https://github.com/rinkelzz/cockpit/actions/workflows/ci.yml)
[](https://github.com/rinkelzz/cockpit/releases)
[](LICENSE)
Ein **Cockpit** für die Synology NAS: Deine **ntfy-Push-Nachrichten** und die **GitHub-Issues** deiner Repos an
einem Ort. Nachrichten bleiben gespeichert, auch wenn der ntfy-Server sie längst verworfen hat. Issues kannst du
direkt im Cockpit **kommentieren, schließen und mit Labels versehen**. Jeder Benutzer hat sein **eigenes Cockpit**
mit eigenen Topics und eigenem GitHub-Token.
> **Stand 0.2:** ntfy-Topics abonnieren (ntfy.sh oder eigener Server, mit oder ohne Anmeldung), GitHub-Issues und
> **Pull Requests** der ausgewählten Repos mit Kommentieren, Schließen und Labels, **GitHub Actions** mit Status und
> **Workflow starten per Klick**, **Textbausteine**, **Suche über alles** und **Browser-Benachrichtigungen**.
> Siehe [Fahrplan](#fahrplan).

## Inhalt
- [Funktionen](#funktionen)
- [Einrichten: ntfy](#einrichten-ntfy)
- [Einrichten: GitHub](#einrichten-github)
- [Mehrere Benutzer](#mehrere-benutzer)
- [Fahrplan](#fahrplan)
- [Installation auf der Synology](#installation-auf-der-synology)
- [Updates über das Paket-Zentrum](#updates-über-das-paket-zentrum)
- [Datensicherung](#datensicherung)
- [Von unterwegs erreichbar machen (Reverse Proxy)](#von-unterwegs-erreichbar-machen-reverse-proxy)
- [Port ändern](#port-ändern)
- [Entwicklung](#entwicklung)
- [English](#english)
## Funktionen
### ntfy-Nachrichten
- **Topics abonnieren** auf [ntfy.sh](https://ntfy.sh) oder einem eigenen ntfy-Server, ohne Anmeldung, mit
Access-Token oder mit Benutzer und Passwort. Mehrere Topics pro Benutzer, jedes mit eigener Farbe.
- Das Cockpit hält im Hintergrund eine **dauerhafte Verbindung** zu jedem Topic offen. Neue Nachrichten erscheinen
nach wenigen Sekunden, auch wenn gerade niemand die App geöffnet hat. Nach einem Neustart holt es alles nach, was
der Server noch hat.
- **Bleibt gespeichert:** ntfy.sh hebt Nachrichten nur etwa 12 Stunden auf, im Cockpit bleiben sie (standardmäßig die
letzten 2000 pro Topic).
- Priorität als Farbbalken, Tags, Klick-Links und Anhänge. Filter nach Topic, Priorität und ungelesen, dazu eine Suche.
Nachrichten lassen sich als gelesen markieren und löschen.
- **Testnachricht** pro Topic. Eine Warnung erscheint, wenn ein Topic auf einem öffentlichen Server leicht zu erraten ist.

### GitHub-Issues
- **Repos anhaken:** eigene Repos, Repos aus Organisationen und solche, in denen du Mitarbeiter bist. Über
`besitzer/name` oder den Link kannst du auch **fremde öffentliche Repos** hinzufügen.
- **Abgleich alle 5 Minuten:** beim ersten Mal alle offenen Issues, danach nur noch Änderungen. Pull Requests werden
übersprungen.
- Liste mit Filtern (Repo, offen/geschlossen, Label, Suche nach Titel, Autor oder `#Nummer`). Neue und geänderte
Issues sind markiert, bis du sie angesehen hast.
- **Aktionen:** kommentieren, „Kommentieren & schließen“, schließen (erledigt oder nicht geplant), wieder öffnen,
Labels setzen. Schließen und Labels gibt es nur bei Repos, in denen du Schreibrechte hast. Kommentieren geht überall
dort, wo es auch auf GitHub geht.
- Nur die REST-API von GitHub, kein GraphQL.

### Pull Requests (0.2)
PRs erscheinen zusammen mit den Issues, gekennzeichnet mit **⑂ PR** bzw. **⑂ Entwurf**. Über den Filter „Art“ siehst du nur
Issues oder nur PRs. Kommentieren, Schließen und Labels funktionieren wie bei Issues.
### GitHub Actions (0.2)
- Reiter **🚦 Actions**: pro Repo die Workflows mit ihrem letzten Lauf (✓ erfolgreich, ✗ fehlgeschlagen, ⏳ läuft) und den
letzten Läufen mit Link zum Log. Repos mit roten oder laufenden Workflows stehen oben.
- **▶ Starten** entspricht „Run workflow“ auf GitHub (auf dem Standard-Branch). Damit startest du z. B. den
**Release-Workflow** direkt aus dem Cockpit. Das klappt bei Workflows mit `on: workflow_dispatch`.
- Fehlgeschlagene Workflows zählen auf der Übersicht und am Reiter. Solange ein Lauf aktiv ist, aktualisiert sich die Seite alle
10 Sekunden.

### Textbausteine, Suche und Benachrichtigungen (0.2)
- **Textbausteine** für Antworten, mit Platzhaltern `{autor}` (wird zu `@name`), `{nummer}`, `{titel}`, `{repo}` und
`{ich}`. Anlegen unter 🔌 Verbindungen, einfügen im Issue über „✎ Textbaustein …“.
- **Suche über alles** in der Kopfzeile (Taste <kbd>/</kbd>): ntfy-Nachrichten, Issues und PRs, auch `#48`.
- **Browser-Benachrichtigungen** pro Gerät, solange das Cockpit offen ist: neue ntfy-Nachrichten ab einer wählbaren
Priorität, neue oder geänderte Issues/PRs und fehlgeschlagene Läufe. Das klappt nur über **https**, also im DSM-Fenster
über https oder über den Reverse Proxy, nicht über http im LAN.

### Übersicht
Kacheln mit ungelesenen Nachrichten, offenen und neuen Issues, darunter die neuesten Nachrichten und die offenen Issues
pro Repo. Die Seite aktualisiert sich von selbst, und die Reiter zeigen die Zahl des Ungelesenen.
### Plattform
- Eigenes **DSM-Fenster** mit Single Sign-on für DSM-Benutzer. Anmeldung mit DSM-Konto (auch mit 2FA) oder einem
eigenen Konto.
- Vier Designs (Klassisch, Synology DSM, Dunkel, Warm & groß), Name und Logo in der Kopfzeile. Läuft auf Handy und Desktop.
- Nächtliche **Datensicherung** in einen freigegebenen Ordner, Wiederherstellen per Klick.
- **Updates über das Paket-Zentrum.** Die App ist ihre eigene Paketquelle.
- **Änderungsprotokoll** (Topics, Tokens, Repo-Auswahl, Kommentare, Schließen, Labels, Anmeldungen) und Mailversand
über deinen SMTP-Server.

## Einrichten: ntfy
1. In der ntfy-App auf dem Handy steht unter „Subscribed topics“ z. B. `ntfy.sh/mein-topic-x7k2`.
2. Im Cockpit: **🔌 Verbindungen → + Topic**. Die ganze Zeile in „Topic“ einfügen, einen Anzeigenamen und eine Farbe
wählen und speichern. Bei ntfy.sh bleibt „Anmeldung“ auf **keine**.
3. Mit **Test** schickst du eine Testnachricht. Sie erscheint im Cockpit und auf dem Handy.

**Wichtig bei ntfy.sh:** Topics auf öffentlichen Servern sind nicht geschützt. Wer den Namen kennt, kann mitlesen und
dir Nachrichten schicken. Nimm deshalb einen **langen, zufälligen Namen**. Das Cockpit behandelt den Topic-Namen wie ein
Passwort: Er wird verdeckt angezeigt und **nicht in Sicherungen** gespeichert. Für einen eigenen ntfy-Server trägst du
dessen Adresse ein (auch im LAN, z. B. `http://192.168.1.20:8090`) und wählst bei Bedarf Access-Token oder Benutzer + Passwort.
## Einrichten: GitHub
1. Auf GitHub einen **Fine-grained Token** anlegen:
[Settings → Developer settings → Fine-grained tokens → Generate new token](https://github.com/settings/personal-access-tokens/new).
- **Repository access:** „All repositories“ oder die gewünschten Repos.
- **Permissions → Repositories → Add permissions:** **Issues**, **Pull requests** und **Actions**, jeweils
„Read and write“. „Metadata: Read“ setzt GitHub selbst. Ohne Actions fehlt nur der Reiter 🚦 Actions,
ohne „Read and write“ bei Actions nur der Knopf „▶ Starten“.
2. Im Cockpit: **🔌 Verbindungen → GitHub** den Token einfügen und speichern. Das Cockpit prüft ihn und lädt deine Repos.
3. Die gewünschten Repos anhaken und **Auswahl speichern**. Der erste Abgleich läuft sofort.
Der Token wird **nicht mitgesichert** und nie wieder angezeigt (nur eine verdeckte Vorschau). Reichen die Rechte nicht,
erscheint eine verständliche Meldung statt „HTTP 403“.

## Mehrere Benutzer
Jeder Benutzer (DSM-Konto oder eigenes Konto) hat sein **eigenes Cockpit**: eigene ntfy-Topics, eigenen GitHub-Token
und eigene Repo-Auswahl. Auch Administratoren sehen fremde Nachrichten, Tokens oder Topics nicht. „Verwaltung“ umfasst
nur Benutzer, Einstellungen, Mail, System (Port, Sicherung, Updates) und das Änderungsprotokoll.
## Fahrplan
| Version | Inhalt |
|---|---|
| **0.1** ✅ | ntfy-Empfang (Hintergrund-Stream, mehrere Topics, Anmeldung), GitHub-Issues mit Kommentieren/Schließen/Labels, Übersicht, mehrere Benutzer |
| **0.2** ✅ | Pull Requests, GitHub Actions (Status, fehlgeschlagene Läufe rot), **Workflow per Klick starten**, Textbausteine, Suche über alles, Browser-Benachrichtigungen |
| 0.3 | Brücke: neue Issues und Kommentare als ntfy-Push aufs Handy (mit Filterregeln pro Repo), Aufbewahrungsfrist einstellbar |
| später | Knopf „Mit GitHub anmelden“ (Device Flow) statt Token |
## Installation auf der Synology
Voraussetzung: DSM 7. Ein Paket für alle Modelle – **Intel/AMD** und **ARM** (ARMv8, ARMv7).
1. Unter [Releases](https://github.com/rinkelzz/cockpit/releases) die neueste
`cockpit-<version>-0001-noarch.spk` herunterladen.
2. DSM → **Paket-Zentrum** → **Manuelle Installation** → SPK auswählen → Hinweis zu Drittanbieter-Paketen bestätigen.
3. Im Assistenten eingeben:
- ein Passwort für den Benutzer `admin` (mindestens 8 Zeichen),
- optional einen **Namen** für die Kopfzeile (z. B. den Firmennamen),
- den **Port** (Standard `8830` – nur ändern, wenn er schon belegt ist).
4. „Cockpit“ erscheint im DSM-Hauptmenü.
Das Paket nutzt das Python der NAS (3.8 bis 3.13). Fehlt es, bricht die Installation mit einem Hinweis ab –
dann im Paket-Zentrum „Python 3.9“ installieren. Die Daten liegen unter `/var/packages/cockpit/var/` und
bleiben bei Updates erhalten. **Beim Deinstallieren werden sie gelöscht** – deshalb die
[Datensicherung](#datensicherung) einrichten.
Die NAS braucht Zugang ins Internet zu `api.github.com` und zu deinem ntfy-Server (bei ntfy.sh: `ntfy.sh`).
## Updates über das Paket-Zentrum
Die App ist ihre eigene Paketquelle – neue Releases von GitHub erscheinen im Paket-Zentrum zum Aktualisieren.
Einmalig einrichten:
1. **Paket-Zentrum → Einstellungen → Allgemein → Vertrauensebene:** „Beliebiger Herausgeber“
(das Paket ist nicht von Synology signiert).
2. **Paket-Zentrum → Einstellungen → Paketquellen → Hinzufügen:** Name `Cockpit`,
Ort `http://127.0.0.1:8830/spk` (bei geändertem Port entsprechend – die genaue Adresse steht in der App
unter **Verwaltung → System → Updates**).
Die App prüft etwa alle 30 Minuten (oder per „Jetzt prüfen“), lädt eine neue SPK auf die NAS und bietet sie dort an.
Die Paketquelle antwortet nur im lokalen Netz.
## Datensicherung
Die App sichert ihre Datenbank (Benutzer, Einstellungen, gespeicherte ntfy-Nachrichten, Issue-Liste, Repo-Auswahl)
jede Nacht (Standard 2 Uhr) in den Paketordner. Weil DSM diesen Ordner beim Deinstallieren löscht und Hyper Backup ihn
nicht erfasst, gehört zusätzlich ein **freigegebener Ordner** dazu:
1. **Systemsteuerung → Freigegebener Ordner** → z. B. `backup` → **Bearbeiten → Berechtigungen** →
oben **System-interner Benutzer** wählen → `cockpit` **Lesen/Schreiben** geben.
2. In der App unter **Verwaltung → System → Datensicherung** den Ordner eintragen, z. B.
`/volume1/backup/cockpit` (die App prüft die Schreibrechte), und die Aufbewahrung in Tagen festlegen.
3. Den freigegebenen Ordner in Hyper Backup aufnehmen.
**Nicht mitgesichert** werden GitHub-Tokens, ntfy-Topic-Namen und -Zugangsdaten sowie das Mail-Passwort. Stellst
du auf derselben NAS wieder her, bleiben die aktuellen erhalten. Auf einer anderen NAS trägt jeder sie unter
„Verbindungen“ neu ein. Vor dem Wiederherstellen wird der aktuelle Stand automatisch gesichert.
## Von unterwegs erreichbar machen (Reverse Proxy)
Die Weboberfläche gibt es standardmäßig nur im DSM-Fenster und über **https** – unverschlüsseltes `http://NAS:8830`
aus dem Netz zeigt eine Hinweisseite (die Paketquelle funktioniert trotzdem). Wer im eigenen LAN doch über
http arbeiten will: Verwaltung → Einstellungen → Zugriff.
Für den Zugriff von außen braucht die App eine eigene https-Adresse, z. B. `https://cockpit.meinedomain.de`:
1. DNS-Eintrag für die Subdomain auf die NAS zeigen lassen (z. B. CNAME auf die DDNS-Adresse).
2. **Systemsteuerung → Sicherheit → Zertifikat**: Let's-Encrypt-Zertifikat für die Subdomain.
3. **Systemsteuerung → Anmeldeportal → Erweitert → Reverse Proxy**: Quelle `HTTPS cockpit.meinedomain.de:443`,
Ziel `HTTP localhost:8830`.
4. In der App unter **Verwaltung → Einstellungen → Öffentliche Adresse** genau diese Adresse eintragen.
**Eigener Proxy auf einem anderen Gerät** (z. B. Nginx Proxy Manager): Proxy Host mit Ziel `http://<IP der NAS>:8830`
und Let's-Encrypt-Zertifikat anlegen und unter **Verwaltung → System → Eigener Reverse Proxy** die IP des Proxys
eintragen. Den Port im Router **nie** direkt freigeben.
## Port ändern
Unter **Verwaltung → System → Port** einen neuen Port eintragen (1025–65535, nicht von DSM belegt). Die App prüft,
ob er frei ist, speichert ihn in `/var/packages/cockpit/var/config.env` und startet sich selbst neu.
Anpassen musst du nur die **Paketquelle** im Paket-Zentrum und das **Ziel im Reverse Proxy**.
## Entwicklung
```bash
pip install -r requirements-dev.txt
pytest -q # alle Tests
CKP_DATA_DIR=./data python -m app.main # http://localhost:8830
```
Beim ersten Start ohne `CKP_ADMIN_PASSWORD` steht das Admin-Passwort in `data/ERSTES_ADMIN_PASSWORT.txt`.
Beispieldaten für Screenshots: `tools/demo.py`, `tools/demo_server.py`, `tools/screenshots.py` (GitHub antwortet dort
mit festen Beispieldaten). Die SPK baut `./synology/build_spk.sh` (lädt die Abhängigkeiten für Python 3.8–3.13 und
alle Prozessoren von PyPI).
- **Technik:** Python + FastAPI + SQLite, statisches HTML/CSS/JS ohne Build-Schritt, keine nativen Bibliotheken.
HTTP zu ntfy und GitHub nur mit der Standardbibliothek. Das Fundament (Anmeldung, DSM-Fenster, Sicherung, Updates)
stammt aus [Ordner-Regal](https://github.com/rinkelzz/ordner-regal) (MIT).
- **Datenbank-Migrationen** über `PRAGMA user_version` in `app/db.py`. Neue Tabellen und Spalten kommen immer als
neuer, nummerierter Schritt dazu.
- **Tests** laufen bei jedem Push auf Python 3.8 und 3.13 (GitHub Actions „Tests“).
- **Release:** Version in `app/__init__.py` und `CHANGELOG.md` eintragen, pushen, dann
**Actions → Release → Run workflow**. Das baut die SPK und legt das GitHub-Release an.
## Lizenz
[MIT](LICENSE) – frei nutzbar, auch kommerziell. Gefällt dir die App? [Spendier mir einen Kaffee ☕](https://buymeacoffee.com/lapalutschi)
## English
**Cockpit** is a Synology DSM 7 package that brings your **ntfy push notifications** and the **GitHub issues** of your
repositories together in one place. It keeps a background stream open to each ntfy topic (ntfy.sh or self-hosted, with
or without auth) and stores the messages, so they outlive the server's cache. Issues of the repositories you select
(your own, organisations, or any public repo) are synced every few minutes via the GitHub REST API, including pull
requests; you can comment, close/reopen and set labels right from the app. A GitHub Actions view shows the latest run per
workflow and lets you trigger `workflow_dispatch` workflows (e.g. your release) with one click. Reply snippets, a global
search and per-device browser notifications are included. Every user gets their own cockpit with their own topics and GitHub
token (fine-grained: *Issues*, *Pull requests*, *Actions* – read and write). Tokens and topic names are treated like passwords and never end up in
backups. DSM single sign-on, nightly backups, updates via Package Center, audit log. One `noarch` package for Intel/AMD
and ARM. The UI is in German. MIT licensed.