Skip to content

Commit b55ce0c

Browse files
muelliradosroka
authored andcommitted
configuration: add defaults
1 parent 35e4ca6 commit b55ce0c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

documentation/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ The `usbguard-daemon.conf` file is loaded by the USBGuard daemon after it parses
1111

1212
* `RuleFile=<path>`
1313
The USBGuard daemon will use this file to load the policy rule set from it and to write new rules received via the IPC interface.
14+
Default: `%sysconfdir%/usbguard/rules.conf`
1415

1516
* `ImplicitPolicyTarget=<target>`
1617
How to treat devices that don't match any rule in the policy.
1718
* allow - authorize the device
1819
* block - deauthorize the device
1920
* reject - logically remove the device node from the system
21+
`Default: block`
2022

2123
* `PresentDevicePolicy=<policy>`
2224
How to treat devices that are already connected when the daemon starts:
@@ -25,6 +27,7 @@ The `usbguard-daemon.conf` file is loaded by the USBGuard daemon after it parses
2527
* reject - remove every present device
2628
* keep - just sync the internal state and leave it
2729
* apply-policy - evaluate the ruleset for every present device
30+
Default: `apply-policy`
2831

2932
* `PresentControllerPolicy=<policy>`
3033
How to treat USB controllers that are already connected when the daemon starts:
@@ -33,9 +36,11 @@ The `usbguard-daemon.conf` file is loaded by the USBGuard daemon after it parses
3336
* reject - remove every present device
3437
* keep - just sync the internal state and leave it
3538
* apply-policy - evaluate the ruleset for every present device
39+
Default: `keep`
3640

3741
* `InsertedDevicePolicy=<policy>`
3842
How to treat USB devices that are already connected after the daemon starts. One of block, reject, apply-policy.
43+
Default: `apply-policy`
3944

4045
* `RestoreControllerDeviceState=<boolean>`
4146
The USBGuard daemon modifies some attributes of controller devices like the default authorization state of new child device instances. Using this setting, you can control whether the daemon will try to restore the attribute values to the state before modification on shutdown.
@@ -46,6 +51,7 @@ The `usbguard-daemon.conf` file is loaded by the USBGuard daemon after it parses
4651

4752
* `IPCAllowedUsers=<username> [<username> ...]`
4853
A space delimited list of usernames that the daemon will accept IPC connections from.
54+
Default: `root`
4955

5056
* `IPCAllowedGroups=<groupname> [<groupname> ...]`
5157
A space delimited list of groupnames that the daemon will accept IPC connections from.
@@ -55,16 +61,20 @@ The `usbguard-daemon.conf` file is loaded by the USBGuard daemon after it parses
5561

5662
* `DeviceRulesWithPort=<boolean>`
5763
Generate device specific rules including the "via-port" attribute.
64+
Default: `false`
5865

5966
* `AuditBackend=<backend>`
6067
USBGuard audit events log backend. The backend value should be one of FileAudit or LinuxAudit.
68+
Default: `FileAudit`
6169

6270
* `AuditFilePath=<filepath>`
6371
USBGuard audit events log file path. Required if AuditBackend is set to FileAudit.
72+
Default: `%localstatedir%/log/usbguard/usbguard-audit.log`
6473

6574
* `HidePII=<boolean>`
6675
Hides personally identifiable information such as device serial numbers and
6776
hashes of descriptors (which include the serial number) from audit entries.
77+
Default: false
6878

6979
## Security Considerations
7080

0 commit comments

Comments
 (0)