From 111dd2a0fb1b75d2c406dab2601171d602642b0f Mon Sep 17 00:00:00 2001 From: rzuasti Date: Tue, 27 Jan 2026 18:29:47 -0500 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 658b95d..727c8c1 100644 --- a/README.md +++ b/README.md @@ -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|