netdata_netdata/packaging/installer/methods/synology.md

Install Netdata on Synology

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 with your suggestions. Thank you!

The one-line installation script works on Synology NAS devices with amd64 architecture. The script installs Netdata to /opt/netdata/.

On current Synology systems (DSM 7.2.2+), the kickstart script automates the entire installation process but doesn't create the necessary netdata user and group. As a result, Netdata operates with root privileges instead. Once installed, it can be controlled using standard systemd commands.

Run as netdata user

By default, Netdata runs as root. To run it as the netdata user instead:

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

   or alternatively from the CLI:

   sudo synouser --add netdata <SomeGoodPassword> "netdata agent" 0 "" 0
   sudo synogroup --add netdata netdata
   

3. Set correct ownership permissions:

   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

   /etc/rc.netdata restart
   

Older systems

For DSM versions older than 7.2.2, additional configuration is required.

Create a Startup Script

Older DSM versions aren't automatically recognized during installation, so you'll need to create a startup script manually:

1. Create /etc/rc.netdata with this script.
2. Make it executable:

   chmod 0755 /etc/rc.netdata
   

3. Enable auto-start by adding to /etc/rc.local:

   # Netdata startup
   [ -x /etc/rc.netdata ] && /etc/rc.netdata start