Schnellstart

Am schnellsten läuft Klokk als einzelner Container mit SQLite – ohne eigenen Datenbankserver. Alle Daten liegen in einem Volume. Für größere Installationen läuft Klokk auch mit PostgreSQL.

Was Sie brauchen

• Einen Server oder Rechner mit Docker (oder Docker Compose).
• Ausgehendes HTTPS zu licensing.klokk.me: Klokk prüft seine Lizenz beim Start und einmal täglich. Ist der Server nicht erreichbar, läuft Klokk bis zu 14 Tage mit dem zuletzt bestätigten Stand weiter. Was dabei übertragen wird, steht in der Datenschutzerklärung.
• Für mehr als einen Test: eine Domain und einen Reverse-Proxy mit HTTPS.

Klokk starten

1. Schlüssel erzeugen. Drei Zufallswerte, einmal erzeugt und sicher aufbewahrt:

   cat > klokk.env <<END
   ACCEPT_TERMS=true
   SESSION_SECRET=$(openssl rand -hex 32)
   CSRF_KEY=$(openssl rand -hex 32)
   DATA_KEY=$(openssl rand -hex 32)
   END
   chmod 600 klokk.env

   ACCEPT_TERMS=true akzeptiert die Nutzungsbedingungen; ohne startet Klokk nicht und schreibt stattdessen den Link ins Log.

2. Container starten.

   docker run

   docker run -d \
     --name klokk \
     -p 8080:8080 \
     -v klokk-data:/app/data \
     --env-file klokk.env \
     -e BASE_URL=http://localhost:8080 \
     -e SESSION_SECURE_COOKIE=false \
     --read-only --tmpfs /tmp \
     --cap-drop ALL --security-opt no-new-privileges \
     klokkme/klokk:stable

   Docker Compose

   docker-compose.yml

   services:
     klokk:
       image: klokkme/klokk:stable
       restart: unless-stopped
       read_only: true
       tmpfs:
         - /tmp
       cap_drop: [ALL]
       security_opt:
         - no-new-privileges:true
       pids_limit: 200
       ports:
         - "8080:8080"
       volumes:
         - klokk-data:/app/data
       env_file: klokk.env
       environment:
         BASE_URL: "http://localhost:8080"
         SESSION_SECURE_COOKIE: "false"
   
   volumes:
     klokk-data:

   docker compose up -d

   SESSION_SECURE_COOKIE=false ist nur zum Ausprobieren über einfaches HTTP. Hinter einem Reverse-Proxy mit HTTPS lassen Sie es weg und setzen BASE_URL auf die öffentliche Adresse (zum Beispiel https://zeit.example.de).

3. Einmalpasswort ablesen. Beim allerersten Start legt Klokk das Konto admin an und schreibt einmalig ein Einmalpasswort ins Log:

   docker logs klokk 2>&1 | grep -A1 "one-time password"

   Wer es lieber selbst wählt, setzt vor dem ersten Start DEFAULT_ADMIN_PASSWORD.

4. Anmelden unter http://localhost:8080 mit dem Benutzernamen admin (oder admin@localhost) und diesem Passwort. Klokk fragt dann nach:

   • einem persönlichen Passwort und
   • der Zwei-Faktor-Authentifizierung – Pflicht für Admins: QR-Code mit einer Authenticator-App scannen und die Wiederherstellungscodes aufbewahren.

DATA_KEY nie ändern oder verlieren

DATA_KEY verschlüsselt die Datenbank. Ohne ihn lässt sie sich nicht mehr öffnen – auch nicht aus einer Sicherung. Bewahren Sie ihn getrennt von den Sicherungen auf, zum Beispiel in einem Passwortmanager. Nutzen Sie nie Beispielwerte aus Anleitungen – sie sind öffentlich. Mehr unter Verschlüsselung.

Erste Schritte in Klokk

Als Super-Admin (admin) richten Sie die Installation ein:

1. Firma anlegen unter Admin → Firmen: Name, Land und Bundesland (für Feiertage), Wochenstunden, Urlaubsregeln und die Abwesenheitsarten, die sie nutzt.

2. Personen anlegen unter Admin → Benutzer – einzeln oder aus einer CSV-Datei importiert. Jede bekommt eine Rolle: Benutzer, Vorgesetzter, Admin (der Firma) oder Prüfer.

3. Personal-Einstellungen abgeben an die Admins der Firma: Sie verwalten für ihre Firma Anträge, Monatsabschluss, Firmenkalender und mehr.

4. E-Mail einrichten (SMTP), damit Einladungen, Passwort-Zurücksetzungen und Benachrichtigungen ankommen.

Aktualisieren

Klokk wird aktualisiert, indem Sie das neue Image holen und den Container neu erstellen; die Datenbank wird beim Start migriert.

docker pull klokkme/klokk:stable
docker rm -f klokk   # die Daten bleiben im Volume
# danach wie oben neu starten

Mit Compose: docker compose pull && docker compose up -d. Lesen Sie vor jedem Update die Versionshinweise – in Klokk hinter der Version in der Fußzeile („Was ist neu“) oder auf klokk.me/changelog. Dort steht, wenn vor dem Update etwas zu tun ist.

Wie es weitergeht

• Docker-Images: Tags und Update-Hinweise.
• Reverse-Proxy: HTTPS mit nginx oder Caddy.
• Umgebungsvariablen: alles, was sich einstellen lässt.