Skip to content

Instantly share code, notes, and snippets.

@SanCoder-Q
Created December 25, 2017 14:29
Show Gist options
  • Star 40 You must be signed in to star a gist
  • Fork 7 You must be signed in to fork a gist
  • Save SanCoder-Q/f3755435e6e8bd46ba95bf0ec54ae1a4 to your computer and use it in GitHub Desktop.
Save SanCoder-Q/f3755435e6e8bd46ba95bf0ec54ae1a4 to your computer and use it in GitHub Desktop.
Synology NAS - How to make a program run at startup
Synology NAS - How to make a program run at startup
The other day I created a little node.js project to keep track of some finances. Synology has a node.js package but that just installs the tools - it has no 'container' or any other support to drop files and have it run automagically. Maybe one day.
In the meantime, you can start your project when you SSH into the NAS. My project has a 'www' script which bootstraps my project, so to start I simply type 'node bin/www' from the project directory. But, it only runs while I'm logged in, and if I log out for any reason, the process dies. That's hardly useful when I'm away from home, or on a different PC. So I decided to have a look at starting my project as a Linux service.
After doing a lot of research into how Synology does services, and a few failed attempts at init scripts, I found that Synology DSM (since version 5 perhaps) bundles Upstart, which is a neat little tool to deal with services on Linux. It's most prevalent on Debian and derivatives (notably Ubuntu). So, here's how I got my node.js application running on startup by using Upstart.
Step 1. Create an Upstart script.
Upstart scripts live in /etc/init by default, and that's also the place they live on your Synology NAS. You name the script 'servicename.conf', where 'servicename' is whatever you want it to be called. I called mine 'foobar' because I'm inventive like that, so the file is /etc/init/foobar.conf.
You can be as simple or as comprehensive as you like. I started by using a very simple script, like the one below.
```
# only start this service after the httpd user process has started
start on started httpd-user
# stop the service gracefully if the runlevel changes to 'reboot'
stop on runlevel [06]
# run the scripts as the 'http' user. Running as root (the default) is a bad idea.
setuid http
# exec the process. Use fully formed path names so that there is no reliance on $PATH
# the 'www' file is a node.js script which starts the foobar application.
exec /usr/bin/node /volume2/code/foobar/bin/www
```
view rawfoobar.conf hosted with ❤ by GitHub
Step 2. Start the service manually
The best part about keeping it simple is that you are more likely to get it running. If there is an error in your script, it won't start and it won't tell you why. It will just say the service could not be found.
To start the script, just type start foobar from the terminal. If it's happy, you'll see the process start and the PID displayed on the console. To stop it again, type 'stop foobar'.
Step 3. Check the script will auto-start
If you pass step 2 OK, then this is just a formality. The script will start when you restart your box. When ready type 'shutdown -r now' and allow your NAS to reboot. When it comes up again, you will be able to see that your service is running by hitting the URL, or by checking the logs which, by default, go to /var/log/upstart - all sysout from your process will go here.
@jjustra
Copy link

jjustra commented Apr 27, 2022

Thank you for this copy of an article. It got me on a good way:) Discusion on original (majikshoe's; see bottom link) is also very interesting and gave me my answer;
On my DSM 6 I've solved it by placing .sh script (with perms 755) in /usr/local/etc/rc.d/
for details see section "Run Scripts When the System Boots" in DSM_Developer_Guide_6_0.pdf :
https://global.download.synology.com/download/Document/Software/DeveloperGuide/Firmware/DSM/6.0/enu/DSM_Developer_Guide_6_0.pdf

original source : https://majikshoe.blogspot.com/2014/12/starting-service-on-synology-dsm-5.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment