Skip to content

Commit 11a0f8c

Browse files
Update Configurations.md
1 parent 591f218 commit 11a0f8c

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

wiki/Configurations.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
### Daemon configuration (>= v1.6.5)
1+
### Daemon configuration (>= v1.7.0)
22

33
The file _/etc/opensnitchd/default-config.json_ holds the daemon configuration:
44

5-
```
5+
```json
66
{
77
"Server": {
88
"Address": "unix:///tmp/osui.sock",
@@ -24,11 +24,11 @@ The file _/etc/opensnitchd/default-config.json_ holds the daemon configuration:
2424
"ActionOnOverflow": "drop"
2525
},
2626
"Rules": {
27-
"Path": "",
27+
"Path": "/etc/opensnitchd/rules/",
2828
"EnableChecksums": true
2929
},
3030
"Ebpf": {
31-
"ModulesPath": "/tmp/ebpf",
31+
"ModulesPath": "/usr/lib/opensnitchd/ebpf/",
3232
"EventsWorkers": 8,
3333
"QueueEventsSize": 0
3434
},
@@ -46,30 +46,32 @@ The file _/etc/opensnitchd/default-config.json_ holds the daemon configuration:
4646
Option | Value
4747
-----------|------
4848
Server.Address | Unix socket (unix:///tmp/osui.sock, the "unix:///" part is mandatory) or TCP socket (192.168.1.100:50051)
49+
_ |If the address is empty, it won't try to connect to the server (>= v1.7.1).
4950
Server.LogFile | file to write logs to (use /dev/stdout to write logs to standard output)
5051
Server.Authentication | https://github.com/evilsocket/opensnitch/wiki/Nodes-authentication#nodes-authentication-added-in-v161
5152
Server.Loggers | https://github.com/evilsocket/opensnitch/wiki/SIEM-integration
5253
DefaultAction [0] | allow, deny, reject (>= 1.6.6)
5354
_ | Warning: _reject_ option may cause in some services (dnsmasq, sshd, tinyproxy, ...) to enter in an infinite loop. Use it **at your own risk**
5455
~DefaultDuration~ | ~once, always, until restart, 30s, 5m, 15m, 30m, 1h~ DEPRECATED
55-
InterceptUnknown [1] | true, false
56+
InterceptUnknown [1] | true, false (see [1] for more information).
57+
_ | Display popups to allow connections not associated with a process. Disabled by default.
5658
ProcMonitorMethod | ebpf, proc, audit
57-
LogLevel | 0 to 4 (debug, info, important, warning, error)
59+
LogLevel | -1 to 4 (trace, debug, info, important, warning, error)
5860
LogUTC | print the logs in UTC format (true, false)
5961
LogMicro | print the logs in microseconds (true, false)
60-
Firewall | "nftables" or "iptables"
61-
Stats.MaxEvents | Max events to send to the GUI every second. If you think that you're missing some connections increased this value.
62+
Firewall | "nftables" (default) or "iptables"
63+
Stats.MaxEvents | Max events to send to the GUI every second. If you think that you're missing some connections, increased this value.
6264
Stats.MaxStats | Max stats per item (port, host, IP, process, etc) to keep in the backlog.
63-
Stats.Workers | Max workers to handle the statistics
65+
Stats.Workers | Max workers to handle the statistics.
6466
Ebpf.ModulesPath (>= v1.6.5) | Alternative location of the eBPF modules (default /usr/lib/opensnitchd/ebpf)
6567
Ebpf.EventsWorkers (>= v1.6.5) | Number of goroutines to handle kernel events (default: 8).
66-
Ebpf.QueueEventsSize (>= v1.6.5) | Max number of events queued. Default 0, meaning that the events will be processed with the available goroutines. If the value is > 0 and the daemon can't handle the events fast enough, they'll be queued. Once the queue is full, it'll behave as it was of size 0.
68+
Ebpf.QueueEventsSize (>= v1.6.5) | Max number of events queued. Default 0, meaning that the events will be processed with the available goroutines. If the value is > 0 and the daemon can't handle the events fast enough, they'll be queued. Once the queue is full, queued elements are discarded.
6769
Rules.Path (>= v1.6.5) | Alternative location of to the rules.
70+
Rules.EnableChecksums (>= v1.7.0)| Obtain processes's checksums and allow create rules to filter by them.
6871
FwOptions.ConfigPath (>= v1.7.0) | Alternative path to the firewall configuration (default /etc/opensnitchd/system-fw.json)
6972
FwOptions.MonitorInterval (>= v1.7.0) | Interval time to check that interception rules are loaded. Default "15s", "0s" disables the monitor (value format in time.Duration: https://pkg.go.dev/time#ParseDuration)
70-
Rules.EnableChecksums (>= v1.7.0)| Obtain processes's checksums and allow create rules to filter by them.
7173
Internal.GCPercent (>= v1.7.0)| Option to configure how often the daemon frees up unused memory (https://tip.golang.org/doc/gc-guide#GOGC).
72-
Internal.FlushConnsOnStart | Option to kill established connections whenever the firewall is reloaded / started.
74+
Internal.FlushConnsOnStart | Option to kill established connections whenever the firewall is reloaded / started. Local connections are excluded.
7375

7476
If you change the configuration or the rules under _/etc/opensnitchd/rules/_, they'll be reloaded automatically. No restart is needed.
7577

0 commit comments

Comments
 (0)