cclohmar/NextNVR
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README — auth is optional, remove.sh, config.json, roadmap

Browse source
This commit is contained in:
Claus Lohmar 2026-08-06 18:28:32 +01:00
parent f280de445f
commit cc972835b0
1 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -54,8 +54,8 @@ STORAGE_PATH=/mnt/recordings ./deploy_nvr.sh
| 💾 **Storage** | Flat per-camera directories, 7-day retention, auto-cleanup |
| 🖥️ **Live Wall** | 4×2 grid with auto-refreshing snapshots. Click for full live stream |
| 🔍 **Playback** | Browse recordings by camera and date with snapshot thumbnails |
| ⚙️ **Setup Wizard** | ONVIF auto-discovery + admin password setup on first run |
| 🔐 **Two-Port Auth** | `:8080` with master login, `:8090` open viewer for LAN guests |
| ⚙️ **Setup Wizard** | ONVIF network scan + camera naming. Add cameras manually too. |
| 🔐 **Two-Port Auth** | `:8080` with optional master login, `:8090` always-open viewer for LAN |
| 🔒 **100% Local** | Everything runs on your hardware. No cloud, no subscriptions, no telemetry |
---
@ -66,14 +66,24 @@ NextNVR runs two HTTP servers:
| Port | Audience | Auth | Access |
|---|---|---|---|
| `8080` | You (admin) | Master login | Live Wall, Playback, Settings |
| `8080` | You (admin) | Optional master login | Live Wall, Playback, Settings |
| `8090` | Guests / LAN | None | Live Wall only |
**First run**: the setup wizard prompts you to set a master username and password. Until you do, both ports are open. Once saved, port 8080 requires login. Port 8090 stays open — ideal for a QR code at a guesthouse: "Watch what we watch."
Auth is disabled by default. To enable it, open Settings → **🔐 Authentication** card, set a master username and password, check "Require login", and save. Port 8090 stays open regardless — ideal for a QR code at a guesthouse: "Watch what we watch."
**Viewer port 8090** can be disabled by setting `viewer.enabled: false` in `config.yaml`.
To reset the master password, edit `/opt/nextnvr/config.json` and set `"auth": {"enabled": false}`, then restart.
To reset the master password, edit `/opt/nextnvr/config.yaml` and set `auth.enabled: false`, then restart.
---
## Removing
```bash
curl -sSLO https://git.lohmar.co.uk/cclohmar/NextNVR/raw/branch/main/remove.sh
chmod +x remove.sh
./remove.sh
```
Stops the service, removes `/opt/nextnvr/`, cleans up systemd. Recordings on disk are untouched.
---
@ -94,6 +104,7 @@ To reset the master password, edit `/opt/nextnvr/config.yaml` and set `auth.enab
| Live wall with snapshot grid + focus view | ✅ Done |
| Playback browser with date presets | ✅ Done |
| 7-day retention with auto-cleanup | ✅ Done |
| Two-port authentication (master + viewer) | ✅ Done |
| **Camera-triggered recording** (ONVIF motion/person detection events via API) | 🔜 Planned |
| **NAS/SMB storage support** (record to network share) | 🔜 Planned |
| **Multi-platform builds** (Raspberry Pi, ARM SBCs) | 🔜 Planned |
@ -114,7 +125,7 @@ sudo systemctl restart nextnvr # restart
sudo journalctl -u nextnvr -f # watch logs
```
Config file: `/opt/nextnvr/config.yaml`
Config file: `/opt/nextnvr/config.json`
Recordings: `/mnt/recordings/`
---