Skip to content

Commit 8e15add

Browse files
authored
Synology install rewrite (#377)
1 parent fb8cdf8 commit 8e15add

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

src/pages/how-to/installation.mdx

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,13 +203,33 @@ brew unlink netbird
203203

204204
### Synology
205205

206-
**Install with one command**
206+
**Installation Steps**
207+
208+
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.
209+
210+
1. Ensure your user has administrative privileges. _Control Panel > User & Group > User > Click User and Edit > User Groups > Ensure “administrators” is checked._
211+
2. Enable SSH Connectivity. _Control Panel > Terminal & SNMP > Terminal > Check the box next to “Enable SSH Service” > Click Apply_
212+
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.
213+
214+
```bash
215+
216+
```
217+
218+
4. Install with one command.
207219

208220
```bash
209221
curl -fsSL https://pkgs.netbird.io/install.sh | sh
210222
```
211223

212-
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.
224+
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.
225+
226+
**Reboot Script**
227+
228+
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.
229+
230+
1. _Control Panel > Task Scheduler > Create > Triggered Task > User defined script_.
231+
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.
232+
3. Next, click on _Task Settings_ and copy/paste the script in the text field under _Run command > User-defined script_.
213233

214234
```sh
215235
#!/bin/sh
@@ -228,7 +248,7 @@ if !(lsmod | grep -q "^tun\s"); then
228248
insmod /lib/modules/tun.ko
229249
fi
230250
```
231-
251+
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.
232252

233253
### Android
234254

0 commit comments

Comments
 (0)