archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-27 14:16:20 +00:00
Code Issues Projects Releases Wiki Activity

docs: improve Synology NAS installation documentation clarity ()

Browse source
This commit is contained in:
Ilya Mashchenko 2025-03-29 16:04:01 +02:00 • committed by GitHub
parent bf6753d86b
commit 5dfdda6cca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 30 additions and 39 deletions

69
packaging/installer/methods/synology.md
View file

@ -1,62 +1,53 @@
# Install Netdata on Synology # Install Netdata on Synology
> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the > This community-maintained guide may not reflect the latest changes.
> details of the installation process, before proceeding. > Please verify the installation steps before proceeding.
> >
> You can help improve this document by > Help improve this guide by [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md) with your suggestions.
> [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md) > Thank you!
> with your recommended improvements or changes. Thank you!
The good news is that our 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/`.
[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.
It your NAS is up-to-date, running at least DSM 7.2.2, the latest kickstart script takes care of everything. 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.
You can start/stop the netdata service using the installed `systemd` and the service runs under the `netdata` user.
## Older systems ## 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 ### 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 By default, Netdata runs as `root` on older systems. To run it as the netdata user instead:
installations run it as the `netdata` user, you might wish to do the same. This requires some extra work:
1. Create a group `netdata` via the Synology group interface. Give it no access to anything. 1. Create a `netdata` group through the Synology control panel (no special access needed)
2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign 2. Create a `netdata` user through the Synology control panel:
the user to the `netdata` group. Netdata will chuid to this user when running. - Assign it to the netdata group
3. Change ownership of the following directories: - Set a random password
- Grant no access permission
```sh 3. Set correct ownership permissions:
```bash
chown -R root:netdata /opt/netdata/usr/share/netdata 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:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata
chown -R netdata:root /opt/netdata/var/log/netdata chown -R netdata:root /opt/netdata/var/log/netdata
``` ````
4. Restart Netdata 4. Restart Netdata
```sh ```sh
/etc/rc.netdata restart /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 Older DSM versions aren't automatically recognized during installation, so you'll need to create a startup script manually:
installed.
DSM versions at the time where using upstart, so an upstart script was required. 1. Create `/etc/rc.netdata` with [this script](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f).
2. Make it executable:
You'll have to do this manually: ```sh
chmod 0755 /etc/rc.netdata
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
``` ```
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>