diff --git a/docs/DEVICES_BULK_EDITING.md b/docs/DEVICES_BULK_EDITING.md new file mode 100644 index 00000000..73e7ab73 --- /dev/null +++ b/docs/DEVICES_BULK_EDITING.md @@ -0,0 +1,24 @@ +# Bulk-edit devices by using via CSV Export/Import + +> [!NOTE] +> As always, backup everything, just in case. + +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. + +![Maintenance > CSV Export](/docs/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) + +![Settings > CSV Backup](/docs/img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png) + +> [!NOTE] +> Keep Linux line endings (sugegsted editors: Nano, Notepad++) + +![Nodepad++ line endings](/docs/img/DEVICES_BULK_EDITING/NOTEPAD++.png) + + + + diff --git a/docs/DEVICE_MANAGEMENT.md b/docs/DEVICE_MANAGEMENT.md index b6f472b1..73f5655c 100755 --- a/docs/DEVICE_MANAGEMENT.md +++ b/docs/DEVICE_MANAGEMENT.md @@ -9,6 +9,11 @@ To edit device information: - Press the "Save" button +> [!NOTE] +> +> [Bulk-edit devices](/docs/DEVICES_BULK_EDITING.md) by using the `CSV Export` functionality in the `Maintenance` section. + + ![Device Details][screen1] diff --git a/docs/NETWORK_TREE.md b/docs/NETWORK_TREE.md index 480691a3..261f170f 100755 --- a/docs/NETWORK_TREE.md +++ b/docs/NETWORK_TREE.md @@ -20,7 +20,7 @@ Make sure you have a root device with the MAC `Internet` (No other MAC addresses In this example you will setup a device named `rapberrypi` as a `Switch` in our network. -### 1) Device details page +### 1. Device details page - Go to the `Devices` (1) page: @@ -35,7 +35,7 @@ In this example you will setup a device named `rapberrypi` as a `Switch` in our - Save your changes (7) -### 1) Network page +### 2. Network page - Navigate to your `Network` (1) page: @@ -45,7 +45,7 @@ In this example you will setup a device named `rapberrypi` as a `Switch` in our - As we asssigned the `raspberrypi` in the previous 1) Device details page section to the `Internet` parent network node in step (6), the link is also showing up in the tree diagram (4) - We can now assign the device `(AppleTV)` (5) to this `raspberrypi` node, representing a network Switch in this example -### 1) Network page with 2 levels +### 3. Network page with 2 levels - After clicking the `Assign` button in the previous section, the `(AppleTV)` (1) device is now connected to our `raspberrypi` (2). @@ -57,3 +57,4 @@ In this example you will setup a device named `rapberrypi` as a `Switch` in our + diff --git a/docs/README.md b/docs/README.md index b61d3f42..212ac134 100755 --- a/docs/README.md +++ b/docs/README.md @@ -50,6 +50,7 @@ There is also an in-app Help / FAQ section that should be answering frequently a - [Settings system](/docs/SETTINGS_SYSTEM.md) - [New Version notifications](/docs/VERSIONS.md) - [Frontend development tips](/docs/FRONTEND_DEVELOPMENT.md) +- [Webhook secrets](/docs/WEBHOOK_SECRET.md) Feel free to suggest or submit new docs via a PR. diff --git a/docs/SMTP.md b/docs/SMTP.md index 184273f2..e1b052dc 100755 --- a/docs/SMTP.md +++ b/docs/SMTP.md @@ -1,6 +1,6 @@ # 📧 SMTP guides -## Use the GMX SMTP server +## Using the GMX SMTP server 1. Go to your GMX account https://account.gmx.com 2. Under Security Options enable 2FA (Two-factor authentication) @@ -22,7 +22,7 @@ ``` -## Use the Gmail SMTP server +## Using the Gmail SMTP server 1. Create an app password by following the instructions from Google, you need to Enable 2FA for this to work. [https://support.google.com/accounts/answer/185833](https://support.google.com/accounts/answer/185833) diff --git a/docs/WEBHOOK_SECRET.md b/docs/WEBHOOK_SECRET.md old mode 100644 new mode 100755 diff --git a/docs/img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png b/docs/img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png new file mode 100755 index 00000000..6dd634d9 Binary files /dev/null and b/docs/img/DEVICES_BULK_EDITING/CSV_BACKUP_SETTINGS.png differ diff --git a/docs/img/DEVICES_BULK_EDITING/MAINTENANCE_CSV_EXPORT.png b/docs/img/DEVICES_BULK_EDITING/MAINTENANCE_CSV_EXPORT.png new file mode 100755 index 00000000..935c4ecc Binary files /dev/null and b/docs/img/DEVICES_BULK_EDITING/MAINTENANCE_CSV_EXPORT.png differ diff --git a/docs/img/DEVICES_BULK_EDITING/NOTEPAD++.png b/docs/img/DEVICES_BULK_EDITING/NOTEPAD++.png new file mode 100755 index 00000000..18acb020 Binary files /dev/null and b/docs/img/DEVICES_BULK_EDITING/NOTEPAD++.png differ