External/oott
1
0
Fork 0
mirror of https://github.com/rzuasti/oott.git synced 2026-07-08 19:21:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: complete sample config, fix README config reference

Browse Source 
- Add screenshots to README "What is OOTT?" section
- Document the "push" notification method and notifications.push.relay_url
- Fix misleading retention duration example (m = minutes, not months)
- Add web_server.api_key to the Nix service example
- Make sample_oott.toml a complete, functional baseline: every option
  present, mutually-exclusive notification provider sections commented out
- Trim completed items from TODO.md

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
rzuasti
2026-06-17 17:14:19 -04:00
co-authored by Claude Opus 4.8
parent dfa4e541c9
commit 4b4828be89
3 changed files with 22 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/sample_oott.toml
+12 -6
View File
@@ -36,14 +36,20 @@ enabled=true # Set to false to disable the DHCP scanner
# UDP/161 from the host running OOTT.
[notifications]
method="pushover" # For now just pushover, you can set this to "none" to avoid sending notifications (it will just log)
# Pick ONE delivery method below, then uncomment the matching section if it needs configuration.
# The provider sections are mutually exclusive: enable only the one that goes with your method.
method="none" # One of: "pushover" (send via Pushover), "push" (native push to the OOTT mobile apps via the project relay), or "none" (don't send, just log)
notify_when_not_seen_for="1w" # Send a notification if a device comes back online after not being seen for this timeframe. Defaults to "1w" if omitted
# The [notifications.pushover] section is only required when method="pushover". For any other
# method (e.g. "none") you can omit this whole section.
[notifications.pushover]
token="" # Your pushover token goes here, just copy&paste from their website after creating the app
user_key="" # User key goes here, this is the account wide code for pushover
# Required when method="pushover" (and only then) — uncomment this section and set method="pushover" above.
# [notifications.pushover]
# token="" # Your pushover token goes here, just copy&paste from their website after creating the app
# user_key="" # User key goes here, this is the account wide code for pushover
# Only used when method="push", and even then optional: with no section the built-in
# project-operated relay is used, so you usually need set nothing. Uncomment only to run your own relay.
# [notifications.push]
# relay_url="https://relay-dzhbmmulaq-uc.a.run.app/v1/push" # Override only if you run your own push relay.
[web_server]
ip_address="0.0.0.0" # IP to bind the web server for the API and web UI to, use 0.0.0.0 to bind it to all interfaces. Defaults to "0.0.0.0" if omitted