diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md index d8bbb0ffb0..7ef1de1973 100644 --- a/packaging/installer/methods/synology.md +++ b/packaging/installer/methods/synology.md @@ -1,62 +1,53 @@ # Install Netdata on Synology -> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the -> details of the installation process, before proceeding. -> -> You can help improve this document by -> [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md) -> with your recommended improvements or changes. Thank you! +> This community-maintained guide may not reflect the latest changes. +> Please verify the installation steps before proceeding. +> +> Help improve this guide by [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md) with your suggestions. +> Thank you! -The good news is that our -[one-line installation script](/packaging/installer/methods/kickstart.md) -works fine if your NAS is one that uses the amd64 architecture. It -will install the content into `/opt/netdata`, making future removal safe and simple. +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/`. -It your NAS is up-to-date, running at least DSM 7.2.2, the latest kickstart script takes care of everything. -You can start/stop the netdata service using the installed `systemd` and the service runs under the `netdata` user. +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. ## Older systems -Older versions of DSM and the kickstart scripts did require some extra steps. +<details> +<summary>For DSM versions older than 7.2.2, additional configuration is required.</summary> ### Run as netdata user -When Netdata is first installed, it will run as _root_. This may or may not be acceptable for you, and since other -installations run it as the `netdata` user, you might wish to do the same. This requires some extra work: +By default, Netdata runs as `root` on older systems. To run it as the netdata user instead: -1. Create a group `netdata` via the Synology group interface. Give it no access to anything. -2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign - the user to the `netdata` group. Netdata will chuid to this user when running. -3. Change ownership of the following directories: - - ```sh +1. Create a `netdata` group through the Synology control panel (no special access needed) +2. Create a `netdata` user through the Synology control panel: + - Assign it to the netdata group + - Set a random password + - Grant no access permission +3. Set correct ownership permissions: + ```bash chown -R root:netdata /opt/netdata/usr/share/netdata chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata chown -R netdata:root /opt/netdata/var/log/netdata - ``` - + ```` 4. Restart Netdata - ```sh /etc/rc.netdata restart ``` -### Create startup script +### Create a Startup Script -Additionally, as of 2018/06/24, the Netdata installer doesn't recognize DSM as an operating system, so no init script is -installed. +Older DSM versions aren't automatically recognized during installation, so you'll need to create a startup script manually: -DSM versions at the time where using upstart, so an upstart script was required. - -You'll have to do this manually: - -1. Add [this file](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f) as `/etc/rc.netdata`. Make it - executable with `chmod 0755 /etc/rc.netdata`. -2. Add or edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot: - - ```text - # Netdata startup - [ -x /etc/rc.netdata ] && /etc/rc.netdata start +1. Create `/etc/rc.netdata` with [this script](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f). +2. Make it executable: + ```sh + chmod 0755 /etc/rc.netdata ``` +3. Enable auto-start by adding to `/etc/rc.local`: + ```sh + # Netdata startup + [ -x /etc/rc.netdata ] && /etc/rc.netdata start + ``` -3. Make sure `/etc/rc.local` is executable: `chmod 0755 /etc/rc.local`. +</details>