From 8acb0a876a5fd625d8a29d1fe1a5abcbb1a782df Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Wed, 26 Nov 2025 10:20:19 +1100 Subject: [PATCH] DOCS: cleanup Signed-off-by: jokob-sk --- docs/DEBUG_INVALID_JSON.md | 6 +++--- docs/DEVICES_BULK_EDITING.md | 16 ++++++++-------- docs/DOCKER_PORTAINER.md | 8 ++++---- docs/FILE_PERMISSIONS.md | 8 ++++---- docs/SYNOLOGY_GUIDE.md | 8 ++++---- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/DEBUG_INVALID_JSON.md b/docs/DEBUG_INVALID_JSON.md index bd66abfb..00b82b0b 100755 --- a/docs/DEBUG_INVALID_JSON.md +++ b/docs/DEBUG_INVALID_JSON.md @@ -3,13 +3,13 @@ Check the the HTTP response of the failing backend call by following these steps: - Open developer console in your browser (usually, e. g. for Chrome, key F12 on the keyboard). -- Follow the steps in this screenshot: +- Follow the steps in this screenshot: ![F12DeveloperConsole][F12DeveloperConsole] - Copy the URL causing the error and enter it in the address bar of your browser directly and hit enter. The copied URLs could look something like this (notice the query strings at the end): - - `http://:20211/api/table_devices.json?nocache=1704141103121` - - `http://:20211/php/server/devices.php?action=getDevicesTotals` + - `http://:20211/api/table_devices.json?nocache=1704141103121` + - `http://:20211/php/server/devices.php?action=getDevicesTotals` - Post the error response in the existing issue thread on GitHub or create a new issue and include the redacted response of the failing query. diff --git a/docs/DEVICES_BULK_EDITING.md b/docs/DEVICES_BULK_EDITING.md index d630a479..0e14081d 100755 --- a/docs/DEVICES_BULK_EDITING.md +++ b/docs/DEVICES_BULK_EDITING.md @@ -4,8 +4,8 @@ NetAlertX allows you to mass-edit devices via a CSV export and import feature, o ## UI multi edit -> [!NOTE] -> Make sure you have your backups saved and restorable before doing any mass edits. Check [Backup strategies](./BACKUPS.md). +> [!NOTE] +> Make sure you have your backups saved and restorable before doing any mass edits. Check [Backup strategies](./BACKUPS.md). You can select devices in the _Devices_ view by selecting devices to edit and then clicking the _Multi-edit_ button or via the _Maintenance_ > _Multi-Edit_ section. @@ -16,23 +16,23 @@ You can select devices in the _Devices_ view by selecting devices to edit and th The database and device structure may change with new releases. When using the CSV import functionality, ensure the format matches what the application expects. To avoid issues, you can first export the devices and review the column formats before importing any custom data. -> [!NOTE] +> [!NOTE] > As always, backup everything, just in case. -1. In _Maintenance_ > _Backup / Restore_ click the _CSV Export_ button. +1. In _Maintenance_ > _Backup / Restore_ click the _CSV Export_ button. 2. A `devices.csv` is generated in the `/config` folder -3. Edit the `devices.csv` file however you like. +3. Edit the `devices.csv` file however you like. ![Maintenance > CSV Export](./img/DEVICES_BULK_EDITING/MAINTENANCE_CSV_EXPORT.png) -> [!NOTE] -> The file containing a list of Devices including the Network relationships between Network Nodes and connected devices. You can also trigger this by acessing this URL: `/php/server/devices.php?action=ExportCSV` or via the `CSV Backup` plugin. (💡 You can schedule this) +> [!NOTE] +> The file containing a list of Devices including the Network relationships between Network Nodes and connected devices. You can also trigger this by acessing this URL: `:20211/php/server/devices.php?action=ExportCSV` or via the `CSV Backup` plugin. (💡 You can schedule this) ![Settings > CSV Backup](./img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png) ### File encoding format -> [!NOTE] +> [!NOTE] > Keep Linux line endings (suggested editors: Nano, Notepad++) ![Nodepad++ line endings](./img/DEVICES_BULK_EDITING/NOTEPAD++.png) diff --git a/docs/DOCKER_PORTAINER.md b/docs/DOCKER_PORTAINER.md index 8246411a..f588d058 100755 --- a/docs/DOCKER_PORTAINER.md +++ b/docs/DOCKER_PORTAINER.md @@ -76,10 +76,10 @@ In the **Environment variables** section of Portainer, add the following: > [!TIP] > If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located). > -> ```bash -> sudo chown -R 20211:20211 /local_data_dir -> sudo chmod -R a+rwx /local_data_dir -> ``` +> `sudo chown -R 20211:20211 /local_data_dir` +> +> `sudo chmod -R a+rwx /local_data_dir1` +> --- diff --git a/docs/FILE_PERMISSIONS.md b/docs/FILE_PERMISSIONS.md index 772c9953..f8c3624b 100755 --- a/docs/FILE_PERMISSIONS.md +++ b/docs/FILE_PERMISSIONS.md @@ -61,10 +61,10 @@ docker run -it --rm --name netalertx --user "0" \ > [!TIP] > If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located). > -> ```bash -> sudo chown -R 20211:20211 /local_data_dir -> sudo chmod -R a+rwx /local_data_dir -> ``` +> `sudo chown -R 20211:20211 /local_data_dir` +> +> `sudo chmod -R a+rwx /local_data_dir1` +> --- diff --git a/docs/SYNOLOGY_GUIDE.md b/docs/SYNOLOGY_GUIDE.md index 192b964b..5db5af2f 100755 --- a/docs/SYNOLOGY_GUIDE.md +++ b/docs/SYNOLOGY_GUIDE.md @@ -86,7 +86,7 @@ services: > [!TIP] > If you are facing permissions issues run the following commands on your server. This will change the owner and assure sufficient access to the database and config files that are stored in the `/local_data_dir/db` and `/local_data_dir/config` folders (replace `local_data_dir` with the location where your `/db` and `/config` folders are located). > -> ```bash -> sudo chown -R 20211:20211 /local_data_dir -> sudo chmod -R a+rwx /local_data_dir -> ``` +> `sudo chown -R 20211:20211 /local_data_dir` +> +> `sudo chmod -R a+rwx /local_data_dir1` +>