docs: improve Synology NAS installation documentation clarity (#19993)
Ilya Mashchenko committed
Mar 29, 2025 at 16:04 UTC
5dfdda6ccacc7f2fcb343ef7933002ff10ec2be3
1 file changed
+30
-39
packaging/installer/methods/synology.md
+30
-39
@@ -1,62 +1,53 @@
1
# Install Netdata on Synology
2
3
-> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
4
-> details of the installation process, before proceeding.
5
->
6
-> You can help improve this document by
7
-> [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md)
8
-> with your recommended improvements or changes. Thank you!
3
+> This community-maintained guide may not reflect the latest changes.
4
+> Please verify the installation steps before proceeding.
5
+>
6
+> Help improve this guide by [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md) with your suggestions.
7
+> Thank you!
8
10
-The good news is that our
11
-[one-line installation script](/packaging/installer/methods/kickstart.md)
12
-works fine if your NAS is one that uses the amd64 architecture. It
13
-will install the content into `/opt/netdata`, making future removal safe and simple.
9
+The [one-line installation script](/packaging/installer/methods/kickstart.md) works on Synology NAS devices with amd64 architecture. The script installs Netdata to `/opt/netdata/`.
10
15
-It your NAS is up-to-date, running at least DSM 7.2.2, the latest kickstart script takes care of everything.
16
-You can start/stop the netdata service using the installed `systemd` and the service runs under the `netdata` user.
11
+For current Synology systems (DSM 7.2.2+), the kickstart script automatically handles the complete installation process. Netdata runs as the `netdata` user and can be managed through standard systemd commands.
12
13
## Older systems
14
20
-Older versions of DSM and the kickstart scripts did require some extra steps.
15
+<details>
16
+<summary>For DSM versions older than 7.2.2, additional configuration is required.</summary>
17
18
### Run as netdata user
19
24
-When Netdata is first installed, it will run as _root_. This may or may not be acceptable for you, and since other
25
-installations run it as the `netdata` user, you might wish to do the same. This requires some extra work:
20
+By default, Netdata runs as `root` on older systems. To run it as the netdata user instead:
21
27
-1. Create a group `netdata` via the Synology group interface. Give it no access to anything.
28
-2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign
29
- the user to the `netdata` group. Netdata will chuid to this user when running.
30
-3. Change ownership of the following directories:
31
-
32
- ```sh
22
+1. Create a `netdata` group through the Synology control panel (no special access needed)
23
+2. Create a `netdata` user through the Synology control panel:
24
+ - Assign it to the netdata group
25
+ - Set a random password
26
+ - Grant no access permission
27
+3. Set correct ownership permissions:
28
+ ```bash
29
chown -R root:netdata /opt/netdata/usr/share/netdata
30
chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata
31
chown -R netdata:root /opt/netdata/var/log/netdata
36
- ```
37
-
32
+ ````
33
4. Restart Netdata
39
-
34
```sh
35
/etc/rc.netdata restart
36
```
37
44
-### Create startup script
38
+### Create a Startup Script
39
46
-Additionally, as of 2018/06/24, the Netdata installer doesn't recognize DSM as an operating system, so no init script is
47
-installed.
40
+Older DSM versions aren't automatically recognized during installation, so you'll need to create a startup script manually:
41
49
-DSM versions at the time where using upstart, so an upstart script was required.
50
-
51
-You'll have to do this manually:
52
-
53
-1. Add [this file](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f) as `/etc/rc.netdata`. Make it
54
- executable with `chmod 0755 /etc/rc.netdata`.
55
-2. Add or edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot:
56
-
57
- ```text
58
- # Netdata startup
59
- [ -x /etc/rc.netdata ] && /etc/rc.netdata start
42
+1. Create `/etc/rc.netdata` with [this script](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f).
43
+2. Make it executable:
44
+ ```sh
45
+ chmod 0755 /etc/rc.netdata
46
```
47
+3. Enable auto-start by adding to `/etc/rc.local`:
48
+ ```sh
49
+ # Netdata startup
50
+ [ -x /etc/rc.netdata ] && /etc/rc.netdata start
51
+ ```
52
62
-3. Make sure `/etc/rc.local` is executable: `chmod 0755 /etc/rc.local`.
53
+</details>