Skip to content

Commit 06ac5c4

Browse files
committed
fix(docs): move sudo/sudoers mentions from Compatibility to Data Collection
1 parent 438e834 commit 06ac5c4

6 files changed

Lines changed: 9 additions & 6 deletions

File tree

check-plugins/dhcp-relayed/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Tests if a DHCP server can offer IPv4 addresses by emulating a DHCP client. Send
66

77
**Data Collection:**
88

9+
* Requires root or sudo to bind to port 68/udp
10+
911
* Constructs and sends a DHCPDISCOVER UDP packet on port 68 (client) to port 67 (server)
1012
* If `--hostname` is specified, sends to that address; otherwise sends as broadcast
1113
* Supports DHCP option 1 (Subnet Mask) and option 118 (Subnet Selection, RFC 3011) for targeting specific subnets
@@ -14,7 +16,7 @@ Tests if a DHCP server can offer IPv4 addresses by emulating a DHCP client. Send
1416

1517
**Compatibility:**
1618

17-
* Linux (requires root or sudo to bind to port 68/udp)
19+
* Linux
1820

1921
**Important Notes:**
2022

check-plugins/file-descriptors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Checks the system-wide file descriptor usage as a percentage of the kernel maxim
66

77
**Data Collection:**
88

9+
* Depending on the user (e.g. running as `icinga`), sudo may be needed to read all process information
910
* Reads `/proc/sys/fs/file-nr` to obtain the number of allocated file handles and the system-wide maximum
1011
* Uses `psutil.process_iter()` to aggregate open file descriptors per process name for the top-N list
1112

1213
**Compatibility:**
1314

1415
* Linux only (reads `/proc/sys/fs/file-nr`)
15-
* Depending on the user (e.g. running as `icinga`), sudo (sudoers) may be needed to read all process information
1616

1717

1818
## Fact Sheet

check-plugins/file-ownership/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Verifies that critical system files have the expected owner and group. Ships wit
66

77
**Data Collection:**
88

9+
* Depending on the file and user (e.g. running as `icinga`), sudo may be needed
910
* Uses `os.stat()` to read file ownership directly, without shelling out to external commands
1011
* Resolves numeric UIDs/GIDs to names. If a UID/GID has no corresponding name, the numeric value is displayed
1112
* Files that do not exist on the system are silently skipped
1213

1314
**Compatibility:**
1415

1516
* Linux only
16-
* Depending on the file and user (e.g. running as `icinga`), sudo (sudoers) may be needed
1717

1818
**Important Notes:**
1919

check-plugins/nextcloud-enterprise/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Retrieves and displays information about an installed Nextcloud Enterprise subsc
66

77
**Data Collection:**
88

9+
* Requires sudo permissions for the UID under which the Nextcloud application runs
910
* Runs Nextcloud `occ` commands via sudo to retrieve subscription key, last response data, and user limit configuration
1011
* Displays subscription details including end date, level, account manager, and per-feature subscription status (groupware, talk, collabora, onlyoffice, outlook, sip_bridge)
1112

1213
**Compatibility:**
1314

1415
* Linux only
15-
* Requires passwordless or otherwise configured sudo permissions for the UID under which the Nextcloud application is running
1616

1717
**Important Notes:**
1818

check-plugins/nextcloud-version/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Checks the installed Nextcloud version against the endoflife.date API and alerts
66

77
**Data Collection:**
88

9+
* Requires sudo permissions for the UID under which the Nextcloud application runs
910
* Runs Nextcloud `occ config:list` via sudo to determine the installed version
1011
* Queries the [endoflife.date API](https://endoflife.date/) for Nextcloud lifecycle data
1112
* Caches the API response in a local SQLite database to reduce API calls
1213

1314
**Compatibility:**
1415

1516
* Must run on the Nextcloud server itself to access the installation directory
16-
* Requires passwordless or otherwise configured sudo permissions for the UID under which the Nextcloud application is running
1717

1818

1919
## Fact Sheet

check-plugins/path-rw-test/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ Tests if a path is writable and readable by creating, writing, reading, and dele
66

77
**Data Collection:**
88

9+
* May require root or sudo depending on the paths being tested
10+
911
* Creates a temporary file in each specified path (and always in the system's temp directory)
1012
* Writes a test string, reads it back, then deletes the temporary file
1113
* Reports which paths failed and which were tested
1214

1315
**Compatibility:**
1416

1517
* Cross-platform: Linux and Windows
16-
* May require root or sudo depending on the paths being tested
1718

1819

1920
## Fact Sheet

0 commit comments

Comments
 (0)