diff --git a/docs/CUSTOM_PROPERTIES.md b/docs/CUSTOM_PROPERTIES.md index 1961eb7b..669fe79a 100755 --- a/docs/CUSTOM_PROPERTIES.md +++ b/docs/CUSTOM_PROPERTIES.md @@ -13,31 +13,6 @@ This functionality allows you to define **custom properties** for devices, which --- -## Defining Custom Properties - -Custom properties are structured as a list of objects, where each property includes the following fields: - -| Field | Description | -|--------------------|-----------------------------------------------------------------------------| -| `CUSTPROP_icon` | The icon (Base64-encoded HTML) displayed for the property. | -| `CUSTPROP_type` | The action type (e.g., `show_notes`, `link`, `delete_dev`). | -| `CUSTPROP_name` | A short name or title for the property. | -| `CUSTPROP_args` | Arguments for the action (e.g., URL or modal text). | -| `CUSTPROP_notes` | Additional notes or details displayed when applicable. | -| `CUSTPROP_show` | A boolean to control visibility (`true` to show on the listing page). | - ---- - -## Available Action Types - -- **Show Notes**: Displays a modal with a title and additional notes. - - **Example**: Show firmware details or custom messages. -- **Link**: Redirects to a specified URL in the current browser tab. (**Arguments** Needs to contain the full URL.) -- **Link (New Tab)**: Opens a specified URL in a new browser tab. (**Arguments** Needs to contain the full URL.) -- **Delete Device**: Deletes the device using its MAC address. -- **Run Plugin**: Placeholder for executing custom plugins (not implemented yet). - ---- ## Usage on the Device Listing Page @@ -74,12 +49,39 @@ Visible properties (`CUSTPROP_show: true`) are displayed as interactive icons in 3. **Device Removal**: - Enable device removal functionality using `CUSTPROP_type: delete_dev`. +--- + +## Defining Custom Properties + +Custom properties are structured as a list of objects, where each property includes the following fields: + +| Field | Description | +|--------------------|-----------------------------------------------------------------------------| +| `CUSTPROP_icon` | The icon (Base64-encoded HTML) displayed for the property. | +| `CUSTPROP_type` | The action type (e.g., `show_notes`, `link`, `delete_dev`). | +| `CUSTPROP_name` | A short name or title for the property. | +| `CUSTPROP_args` | Arguments for the action (e.g., URL or modal text). | +| `CUSTPROP_notes` | Additional notes or details displayed when applicable. | +| `CUSTPROP_show` | A boolean to control visibility (`true` to show on the listing page). | + +--- + +## Available Action Types + +- **Show Notes**: Displays a modal with a title and additional notes. + - **Example**: Show firmware details or custom messages. +- **Link**: Redirects to a specified URL in the current browser tab. (**Arguments** Needs to contain the full URL.) +- **Link (New Tab)**: Opens a specified URL in a new browser tab. (**Arguments** Needs to contain the full URL.) +- **Delete Device**: Deletes the device using its MAC address. +- **Run Plugin**: Placeholder for executing custom plugins (not implemented yet). + + --- ## Notes - **Plugin Functionality**: The `run_plugin` action type is currently not implemented and will show an alert if used. -- **Custom Icons (Experimental 🧪)**: Use Base64-encoded HTML to provide custom icons for each property. You can add your icons in Setttings via the `CUSTPROP_icon` settings +- **Custom Icons (Experimental 🧪)**: Use Base64-encoded HTML to provide custom icons for each property. You can add your icons in Setttings via the `CUSTPROP_icon` settings - **Visibility Control**: Only properties with `CUSTPROP_show: true` will appear on the listing page. This feature provides a flexible way to enhance device management and display with interactive elements tailored to your needs. diff --git a/docs/FILE_PERMISSIONS.md b/docs/FILE_PERMISSIONS.md index b6a25896..4621607e 100755 --- a/docs/FILE_PERMISSIONS.md +++ b/docs/FILE_PERMISSIONS.md @@ -38,9 +38,9 @@ NetAlertX requires certain paths to be writable at runtime. These paths should b > All these paths will have **UID 20211 / GID 20211** inside the container. Files on the host will appear owned by `20211:20211`. -## Eunning as `root` +## Running as `root` -You can change the default PUID and GUID with env variables: +You can override the default PUID and PGID using environment variables: ```yaml ... @@ -50,6 +50,16 @@ You can change the default PUID and GUID with env variables: ... ``` +To run as the root user, it usually looks like this (verify the IDs on your server first by executing `id root`): + +```yaml +... + environment: + PUID: 0 # Runtime PUID override, set to 0 to run as root + PGID: 100 # Runtime PGID override +... +``` + ### Solution 1. **Run the container once as root** (`--user "0"`) to allow it to correct permissions automatically: