Caution

Migrated to https://git.nerdberg.de/Nerdberg/Nerdlock

Nerdlock

Türsteuerung für den Schacht 2 des Nerdberges mit Nuki Smart Locks, Passkeys und Rollenverwaltung.

Was ist das?

Nerdlock ist eine Webanwendung, die den Zugang zum Schacht 2 gibt. Mitglieder können per Webinterface Türen auf- und zusperren, Admins verwalten User und Rollen, Admins können nachträglich nachvollziehen, wer wann gesperrt hat.

Das Ganze läuft auf einem Raspberry Pi, der per Bluetooth mit euren Nuki-Schlössern spricht.

Features

• Türsteuerung: Unlock, Lock, Unlatch per Webinterface
• Passkeys: Passwordless Login mit Fingerabdruck oder Face ID
• Admin-Verwaltung: User-Verwaltung und Rollenzuweisung
• Zugriffslogs: Wer hat wann welche Tür geöffnet
• Nuki-Integration: Batteriestatus und automatische Status-Updates
• Mail-Benachrichtigungen: Neue User bekommen ihre Zugangsdaten per Mail
• Migrations-System: Datenbank-Setup per Flask-Migrate

Hardware

• Raspberry Pi 3/4/5 (getestet auf RPi 4)
• Nuki Smart Lock (mit Bluetooth-Modul)
• Optional: Domain mit HTTPS für Passkeys

Installation auf Raspberry Pi

1. System vorbereiten

# System updaten
sudo apt update && sudo apt upgrade -y

# Python 3.13 installieren (wenn nicht vorhanden, mindestens 3.11)
sudo apt install python3.13 python3.13-venv python3.13-dev

# Bluetooth-Dependencies
sudo apt install bluetooth bluez libbluetooth-dev

# Git installieren
sudo apt install git

2. Projekt klonen

cd /home/pi
git clone https://github.com/Nerdbergev/Nerdlock.git
cd Nerdlock

3. Virtual Environment erstellen

python3.13 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

4. Umgebungsvariablen einrichten

Erstellt eine .env Datei:

nano .env

Inhalt (anpassen!):

# Flask
SECRET_KEY=hier-ein-langer-zufälliger-string-generieren
SECURITY_PASSWORD_SALT=noch-ein-zufälliger-salt

# Datenbank (SQLite, wird in instance/ erstellt)
# DATABASE_URL wird automatisch auf instance/nerdlock.db gesetzt

# Mail (für User-Einladungen)
MAIL_SERVER=smtp.example.com
MAIL_PORT=587
MAIL_USE_TLS=1
[email protected]
MAIL_PASSWORD=your-mail-password
[email protected]

# WebAuthn (für Passkeys)
WEBAUTHN_RP_ID=your-domain.com
WEBAUTHN_RP_NAME=Dein Hackspace
WEBAUTHN_ORIGIN=https://your-domain.com

# Nuki (später, nach Pairing)
NUKI_BUILDING_ENABLED=0
NUKI_BUILDING_MAC=
NUKI_BUILDING_UNLATCH=1

NUKI_HACKSPACE_ENABLED=0
NUKI_HACKSPACE_MAC=
NUKI_HACKSPACE_UNLATCH=1

NUKI_APP_ID=355740770
NUKI_NAME=Nerdlock
NUKI_CHECK_INTERVAL=900

Secrets generieren:

python3 -c "import secrets; print(secrets.token_hex(32))"

5. Datenbank initialisieren

Die Datenbank wird mit Flask-Migrate initialisiert:

source .venv/bin/activate
flask db upgrade

Dies erstellt:

• Die Datenbank in instance/nerdlock.db
• Alle Tabellen (User, Role, WebAuthnCredential, DoorAccessLog)
• Einen initialen Admin-User:
  • Email: [email protected]
  • Username: admin
  • Passwort: changeme

WICHTIG: Ändere das Admin-Passwort nach dem ersten Login!

Siehe migrations/README.md für weitere Details zum Migrations-System.

6. Nuki pairen (optional)

Wenn ihr Nuki Smart Locks habt:

python3 scripts/pair_nuki.py

Das Script findet die Nukis, fragt nach der 6-stelligen PIN und speichert die Pairing-Daten. Danach zeigt es euch die ENV-Variablen, die ihr in die .env eintragen müsst.

7. App starten (Entwicklung)

source .venv/bin/activate
export FLASK_APP=wsgi:app
export FLASK_ENV=development
flask run --host=0.0.0.0 --port=5000

Jetzt auf http://raspberry-ip:5000 zugreifen und mit dem Admin-Account einloggen.

8. Produktiv-Setup mit Gunicorn + systemd

Erstellt einen systemd-Service:

sudo nano /etc/systemd/system/nerdlock.service

Inhalt:

[Unit]
Description=Nerdlock Hackspace Access Control
After=network.target

[Service]
Type=simple
User=pi
WorkingDirectory=/home/pi/Nerdlock
Environment="PATH=/home/pi/Nerdlock/.venv/bin"
EnvironmentFile=/home/pi/Nerdlock/.env
ExecStart=/home/pi/Nerdlock/.venv/bin/gunicorn \
    --bind 0.0.0.0:5000 \
    --workers 2 \
    --timeout 60 \
    --access-logfile /home/pi/Nerdlock/logs/access.log \
    --error-logfile /home/pi/Nerdlock/logs/error.log \
    wsgi:app
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Gunicorn installieren und Service starten:

# Gunicorn installieren
source .venv/bin/activate
pip install gunicorn

# Log-Verzeichnis erstellen
mkdir -p logs

# Service aktivieren
sudo systemctl daemon-reload
sudo systemctl enable nerdlock
sudo systemctl start nerdlock

# Status checken
sudo systemctl status nerdlock

9. Nginx als Reverse Proxy (empfohlen)

Für HTTPS und bessere Performance:

sudo apt install nginx certbot python3-certbot-nginx

Nginx-Config erstellen:

sudo nano /etc/nginx/sites-available/nerdlock

Inhalt:

server {
    listen 80;
    server_name your-domain.com;

    location / {
        proxy_pass http://127.0.0.1:5000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

Aktivieren:

sudo ln -s /etc/nginx/sites-available/nerdlock /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx

HTTPS einrichten:

sudo certbot --nginx -d your-domain.com

Verwendung

User anlegen

Als Admin einloggen → Admin-Panel → "Neuen User anlegen"

User bekommt eine Mail mit Passwort. Danach kann er sich einloggen und ein Passkey einrichten.

Rollen verwalten

Aktuell gibt es nur die admin Rolle:

• admin: Volle Kontrolle über alle Türen und User-Verwaltung

Weitere Rollen können bei Bedarf über das Migrations-System hinzugefügt werden.

Türen steuern

Nach Login auf "Türen" → Gewünschte Tür auswählen → Unlock/Lock/Unlatch

Bulk-Actions: Alle Türen auf einmal steuern (nur Unlock/Lock).

Logs anschauen

Unter "Logs" sieht jeder User seine eigenen Zugriffe. Admins sehen alle.

Filter nach Tür und Aktion möglich.

Entwicklung

Tests laufen lassen

source .venv/bin/activate
pytest tests/

Aktuell: 32 Tests, alle sollten bestehen

Datenbank-Migrations

# Neue Migration erstellen (nach Model-Änderungen)
flask db migrate -m "Beschreibung"

# Migration anwenden
flask db upgrade

# Migration rückgängig machen
flask db downgrade

Pre-commit hooks installieren

source .venv/bin/activate
pip install pre-commit black isort flake8 commitizen
pre-commit install
pre-commit install --hook-type commit-msg

Commit messages

Wir nutzen Conventional Commits:

cz commit

Oder manuell:

git commit -m "feat(doors): add bulk unlock action"
git commit -m "fix(auth): fix passkey registration for Firefox"

Troubleshooting

Bluetooth-Probleme

# Bluetooth-Status checken
sudo systemctl status bluetooth

# Bluetooth neustarten
sudo systemctl restart bluetooth

# Geräte scannen
sudo hcitool lescan

Nuki findet sich nicht

• Nuki muss in Bluetooth-Reichweite sein (~10m)
• Pairing-Modus aktivieren (Taste am Nuki drücken)
• Pi-Bluetooth muss eingeschaltet sein
• Nur ein Gerät kann gleichzeitig pairen

App startet nicht

# Logs checken
sudo journalctl -u nerdlock -f

# Oder direkt:
tail -f logs/error.log

Passkeys funktionieren nicht

• HTTPS ist Pflicht (außer localhost)
• WEBAUTHN_RP_ID muss zur Domain passen
• WEBAUTHN_ORIGIN muss zum Browser-URL passen
• Browser muss Passkeys unterstützen (Chrome, Firefox, Safari)

Lizenz

MIT - macht damit was ihr wollt, aber ohne Gewähr.

Credits

Gebaut fürs Nerdberg e.V. Hackspace. Ihr dürft es gerne für euren Space verwenden!

Bei Fragen oder Problemen: Issue aufmachen oder Pull Request schicken.