Skip to content

Synology install rewrite #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2025
Merged

Synology install rewrite #377

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
727cdb5
Synology install rewrite
TechHutTV Jun 24, 2025
ea3e801
Update installation.mdx
TechHutTV Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions src/pages/how-to/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
3. Next, click on _Task Settings_ and copy/paste the script in the text field under _Run command > User-defined script_.

```sh
#!/bin/sh
Expand All @@ -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

Expand Down