From 727cdb5a2b5a1d2de850b28def4020f6f497cdba Mon Sep 17 00:00:00 2001 From: Brandon Hopkins Date: Mon, 23 Jun 2025 19:16:07 -0700 Subject: [PATCH 1/2] Synology install rewrite Adding additional steps and clarification. --- src/pages/how-to/installation.mdx | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/src/pages/how-to/installation.mdx b/src/pages/how-to/installation.mdx index c5307921..5871378f 100644 --- a/src/pages/how-to/installation.mdx +++ b/src/pages/how-to/installation.mdx @@ -203,13 +203,33 @@ brew unlink netbird ### Synology -**Install with one command** +**Installation Steps** + +Installing a NetBird Peer on Synology will require a few additional steps compared to a typical Linux install despite using the same single line command to get everything going. + +1. Ensure your user has administrative privileges. _Control Panel > User & Group > User > Click User and Edit > User Groups > Ensure “administrators” is checked._ +2. Enable SSH Connectivity. _Control Panel > Terminal & SNMP > Terminal > Check the box next to “Enable SSH Service” > Click Apply_ +3. Login to your user using SSH. If you’re unsure if your Synology IP address it can be found under _Control Panel > Info Center > Network > DNS_ or using the [Synology Find Tool](https://finds.synology.com/). Open a terminal and run the command to connecting replacing the user and IP address with your own. + +```bash +ssh user@192.168.0.53 +``` + +4. Install with one command. ```bash curl -fsSL https://pkgs.netbird.io/install.sh | sh ``` -For NetBird to work on Synology after a reboot, you need to run this script every time you reboot your NAS. To automate this process, you can create a scheduled task in the Synology DSM. +5. Add your Synology NAS as a Peer using the steps from [Add peers to your NetBird network](https://docs.netbird.io/how-to/add-machines-to-your-network) in the documentation. + +**Reboot Script** + +In some cases on Synology, the NetBird service wont have the correct modules loaded on a reboot. In this case you’ll need to run a script every time you reboot your NAS. To automate this process, you can create a scheduled task in the Synology DSM. + +1. _Control Panel > Task Scheduler > Create > Triggered Task > User defined script_. +2. Now you’ll have a _Create Task_ dialog box. Give a task name such as “Netbird Reboot”. Set the _User > Root_ and the _Event > Boot-up_. Make sure the Enable Box is checked. +3. Next, click on _Task Settings_ and copy/paste the script in the text field under _Run command > User-defined script_. ```sh #!/bin/sh @@ -228,7 +248,7 @@ if !(lsmod | grep -q "^tun\s"); then insmod /lib/modules/tun.ko fi ``` - +4. If you’d like to see the logs for this task, select the task you create and click on Settings. Check the box that says Save output results, select a save location, and click OK. Now, if you select the task and **Action > View Result**, you’ll see any error logs and status. ### Android From ea3e801865d2c3ad91b8bcf685e641b69f3f7f80 Mon Sep 17 00:00:00 2001 From: Brandon Hopkins <76761586+TechHutTV@users.noreply.github.com> Date: Tue, 24 Jun 2025 09:09:13 -0700 Subject: [PATCH 2/2] Update installation.mdx Spelling fix --- src/pages/how-to/installation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/how-to/installation.mdx b/src/pages/how-to/installation.mdx index 5871378f..cd641f23 100644 --- a/src/pages/how-to/installation.mdx +++ b/src/pages/how-to/installation.mdx @@ -225,7 +225,7 @@ curl -fsSL https://pkgs.netbird.io/install.sh | sh **Reboot Script** -In some cases on Synology, the NetBird service wont have the correct modules loaded on a reboot. In this case you’ll need to run a script every time you reboot your NAS. To automate this process, you can create a scheduled task in the Synology DSM. +In some cases on Synology, the NetBird service will not have the correct modules loaded on a reboot. In this case you’ll need to run a script every time you reboot your NAS. To automate this process, you can create a scheduled task in the Synology DSM. 1. _Control Panel > Task Scheduler > Create > Triggered Task > User defined script_. 2. Now you’ll have a _Create Task_ dialog box. Give a task name such as “Netbird Reboot”. Set the _User > Root_ and the _Event > Boot-up_. Make sure the Enable Box is checked.