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

Update README.md

Browse Source
This commit is contained in:
rzuasti
2026-01-27 18:29:47 -05:00
parent 732c9222b3
commit 111dd2a0fb
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -10
View File
@@ -26,13 +26,13 @@ If you are using Docker I recommend writing the config using TOML, [here](https:
### Options list
|Option|Sample value|Description|
|------|-------------|-----------|
|database.path|/var/lib/oott.db|Location of the system database|
|networking.interface|eno1|Network interface to use for scans|
|log.level|info|Log level to use (trace, debug, info, warn, error)|
|timings.wait_between_scans|15m|Time to wait between each network scan (you can express it in seconds, minutes, hours, etc. as a suffix - for example: 30s, 10m, 1h)|
|timings.arp_sender_timeout|1m|If the ARP sender process takes longer than this it will be stopped (for a class C network - 254 IPs - it should take less than a minute)|
|timings.arp_scan_duration|10m|How long to wait for response packets on each scan (5m to 10m is a good timeframe for a class B or C network)|
|notifications.method|pushover|For now just pushover, you can set this to "none" to avoid sending notifications (it will just log)|
|notifications.notify_when_not_seen_for|1w|Send a notification if a device comes back online after not being seen for this timeframe (you can use hours, weeks, etc.)|
|notifications.pushover.token||Your pushover token goes here, just copy&paste from their website after creating the app|
|notifications.pushover.user_key||User key goes here, this is the account wide code for pushover|
|`database.path`|`/var/lib/oott.db`|Location of the system database|
|`networking.interface`|`eno1`|Network interface to use for scans|
|`log.level`|`info`|Log level to use (trace, debug, info, warn, error)|
|`timings.wait_between_scans`|`15m`|Time to wait between each network scan (you can express it in seconds, minutes, hours, etc. as a suffix - for example: 30s, 10m, 1h)|
|`timings.arp_sender_timeout`|`1m`|If the ARP sender process takes longer than this it will be stopped (for a class C network - 254 IPs - it should take less than a minute)|
|`timings.arp_scan_duration`|`10m`|How long to wait for response packets on each scan (5m to 10m is a good timeframe for a class B or C network)|
|`notifications.method`|`pushover`|For now just pushover, you can set this to "none" to avoid sending notifications (it will just log)|
|`notifications.notify_when_not_seen_for`|`1w`|Send a notification if a device comes back online after not being seen for this timeframe (you can use hours, weeks, etc.)|
|`notifications.pushover.token`||Your pushover token goes here, just copy&paste from their website after creating the app|
|`notifications.pushover.user_key`||User key goes here, this is the account wide code for pushover|