BeatificaBytes

Post under construction…

Connect on a Synology

• via SSH console: see here
• via GateOne on DSM: see here

Synology Commands

• Located in /usr/syno and /usr/syno/sbin resp. for binaries and script requiring root privileges
• Interesting scripts in /usr/syno/etc.defaults/rc.sysv/ (to be used as root)
  • ./apparmor.sh {start|stop|restart|try-restart|reload|force-reload|status|kill|add_packages_profile|remove_packages_profile}
  • ./share-preapre.sh start
  • ./sftp.sh reload
  • ./tfpt.sh reload
  • ./ningx.sh reload
  • ./synomount.sh {start|stop}
  • ./pgsql.sh {start|stop|restart|reload|status}
  • ./S80samba.sh {start|stop}
  • ./S83nfsd.sh {start|stop}
  • ./inetd.sh { prestart_telnetd | poststop_telnetd | prestart_cups_lpd | poststop_cups_lpd }

Other command paths:

• installed via opkg: /opt/bin and /opt/sbin

Interesting Paths

• Web folder: /var/services/web
  • Reference onto /volumex/web
• Package folder: /var/packages/<Package Name>
  • See 3rd Party Packages bellow
• Link onto all 3rd party packages
  • /usr/syno/synoman/webman/3rdparty

Synology Services

• Names:
  • Packages’ service name: pkgctl-<package>
  • Ex.: pkgctl-WebStation
  • For others, execute: /usr/syno/sbin/synoservicecfg –list
• Config
  • path: /usr/syno/etc/synoservice.d/<service>
•  Commands:

Need to be root:

• • /usr/syno/sbin/synoservice −−help
  • /usr/syno/sbin/synoservicecfg −−help (alias of above)
  • /usr/syno/sbin/synoservicectl −−help (limited features of above)
  • /usr/syno/sbin/synoservicemigrate −−help
  • Ex.: synoservice −−restart pkgctl-WebStation

No need to be root:

• • /usr/syno/sbin/synopkg
  • /usr/syno/sbin/synopkgctl
•  Status for Packages:
  • Each service has a file named “enabled” which is created when the service is started via the Packager Center UI (/var/packages/<package>/enabled).
  • This file is deleted once one stops the service via the Package Center UI.
  • This file is not deleted if one stops the service with the command line /usr/syno/sbin/synoservicecfg –stop pkgctl-<package>
  • This ile is not recreated if one (re)starts the service with the command line /usr/syno/sbin/synoservicecfg –start pkgctl-<package>
  • Command line ex.:
    • /usr/syno/sbin/synoservicecfg –stop “pkgctl-AudioStation”
    • output: warn: The runkey of service [pkgctl-AudioStation] has been set to “No”
    • /usr/syno/sbin/synoservicectl –stop “pkgctl-AudioStation”
    • output: pkgctl-AudioStation stoped.
• List all Services
  • /usr/syno/sbin/synoservicecfg –list
  • /usr/syno/sbin/synoservicecfg –list-config
• More options
  • /usr/syno/sbin/synoservicecfg —help-dev

3rd Party Packages

• Access path: /usr/syno/synoman/webman/3rdparty/
  • This is a link to the binaries/web page/scripts of the actual application to run.
  • ls -la /usr/syno/synoman/webman/3rdpart/<packagename> will give you the actual path
• Access Url: http://<YourNas>:<Admin Port>/webman/3rdparty/<Package Name>/….
  • To check the URL of a 3rd Party Package, simply Right Click on it in DSM’s Main Menu and select “Open in new window”
• Setup path (scripts, config, enabled “flag”, INFO): /var/packages/<package>/
  • This is the location of all info used be DSM to install, access and run the package
  • Link onto the package itself /var/packages/<package>/target => /volume<x>/@appstore/<Package Name>
    • target/ is only created after the installation and can therefore not be used in Package’s pre-installation script.
  • Link onto the package configuration : /var/packages/<package>/etc => /usr/syno/etc/packages/<Package Name>
    • etc/ is only created after the installation and can therefore not be used in Package’s pre-installation script.
• Installation path: /volume<x>/@appstore/<package>
  • This is the path to the binaries/web page/scripts of the application.
  • Found via: ls -la /var/packages/<package>/target
• Configuration path: /usr/syno/etc/packages/<package>
  • This is the path where the configuration settings of the application can be stored.
  • This path is not deleted during an upgrade/uninstallation.
  • Found via: ls -la /var/packages/<package>/etc
• List the custom feeds: cat /usr/syno/etc/packages/feeds

So, concretely, the structure of a Package Folder under /var/packages/<Package name> is like:

• conf/
• enabled
• etc -> /usr/syno/etc/packages/<Package name>
• INFO
• scripts/
  • postinst
  • postuninst
  • postupgrade
  • preinst
  • preuninst
  • preupgrade
  • start-stop-status
• target -> /volume<x>/@appstore/<Package name>
• WIZARD_UIFILES/
  • install_uifile or install_uifile.sh
  • uninstall_uifile or uninstall_uifile.sh
  • upgrade_uifile or upgrade_uifile.sh
  • NB.: each file can be postfixed with the language. Ex.: install_uifile_enu or install_uifile_fre

NB: Sometimes, ‘target’ can be a link on -> /usr/local/packages/@appstore/<Package name>

Volumes

• Volume Raid storage calculator: https://www.synology.com/fr-fr/support/RAID_calculator

Logs

• Main Log path: /var/log/
• Package installation log: /var/log/synopkg.log
• Services log:  /var/log/synoservice.log
• Services’ path start/stop logs: /var/log/startup
• Apache’s log: /usr/local/etc/apache22/logs /usr/local/etc/apache24/logs
• nginx’s log: /var/log/nginx/

If something goes wrong and you look for information, delete all existing logs (rm -R) and redo the failing operation. Next, look for newly created logs 😉

Web Server

The Web server can be nginx, apache22 or apache24, as:

• Configured globally in the Web Station > General Settings > HTTP back end Server or
• Configure per Virtual Host in Web Station > Virtual Host

Config files are per Web server types:

• Apache 22’s configs are under /usr/local/etc/apache22. Ex.:
  • virtualhost config file: /usr/local/etc/apache22/sites-enabled/httpd-vhost.conf (notice: changes in this file are lost after restarting the Web Station)
  • httpd conf file:  /usr/local/etc/apache22/conf/httpd22.conf
• Apache 24’s configs are under /usr/local/etc/apache24
• Nginx’s configs are under usr/local/etc/nginx

But also in the Web Station configs:

• Virtual Host, depending if using php56 or php 70, are also in  /var/packages/WebStation/etc/php56/conf.d/webstation_vhost.ini (notice: changes in this file are lost after restarting the Web Station)

Restart Web Server:

• synoservicecfg −−restart nginx
• synoservice −−restart pkgctl-Apache2.4
• synoservice −−restart pkgctl-WebStation

Interesting website info here.

Plex Server

• Plex Media Server data path: /Volume<x>/Plex/Library/Application Support/Plex Media Server/
• Complete Server Backup:
  • Stop Plex Media Server (via the Package Center)
  • Copy the directory mentioned above to backup Plex’s database et configuration.
  • Restart Plex Media Server
• Database Backup:
  • Backups are in /Volume<x>/Plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases/
  • Stop Plex Media Server (via the Package Center)
  • Move away the followin file
    • com.plexapp.plugins.library.db
    • com.plexapp.plugins.library.db-shm
    • com.plexapp.plugins.library.db-wal
  • Rename the latest (or any older) com.plexapp.plugins.library.db-YYYY-MM-DD into com.plexapp.plugins.library.db
  • Restart Plex Media Server

Synology Certificates

They are (in most recent DSM version) under /usr/syno/etc/certificate/system

Synology Model

• Displays the CPU: cat /proc/cpuinfo
• Or simply: uname -a
• What kind of CPU does my NAS have?

Notifications

• Notification messages: /usr/syno/synoman/webman/texts/enu/mails
• Notification sending mode: /usr/syno/etc/notification/notification_filter.settings
• Other Notification messages (unknown usage): /usr/local/share/notification/dsm/enu/mails
• Command:
  • /usr/syno/bin/synonotify <notification>  ‘{“[%VAR1%]”: “value1”, “[%VAR2%]”: “value2”}’
• Debugging:
  • syno_hibernate_debug_tool –enable 10
  • syno_hibernate_debug_tool –disable

Event Logs

• Event messages: Events : /usr/syno/synosdk/texts/enu/events
• Command:
  • synologset1 [sys | man | conn] [info | warn | err] eventID(%X) [substitution strings…]

Package Installation scripts

• Documentation about installation scripts are here .
• The etc folder of the package is a link onto /usr/syno/etc/packages/<Package Name>/
• A script must exit 0 to succeed. Any other value will fail the installation/upgrade/uninstallation.
• One can redirect all errors into the log with code like this:

• All information logged in $SYNOPKG_TEMP_LOGFILE are displayed at the end of the installation/upgrade/uninstallation in any cases (success or failure).
• Add a <br> at the end of each line in $SYNOPKG_TEMP_LOGFILE to have a nice display. Ex.: sed -i ‘s/$/<br>/’ “$SYNOPKG_TEMP_LOGFILE”
• One can decide to fail an installation/upgrade/uninstallation with code like this:

In the ‘preuninst’ script:

if [ “${SYNOPKG_PKG_STATUS}” == “UNINSTALL” ]; then
${SERVICETOOL} –remove-configure-file –package $<Package Name>.sc >> /dev/null
fi

The structure of the <Package Name>.sc file is described here https://help.synology.com/developer-guide/integrate_dsm/install_ports.html

Following ports are used by Synology : https://www.synology.com/en-us/knowledgebase/DSM/tutorial/Network/What_network_ports_are_used_by_Synology_services

Using commands is only required with firmware version < 6.0-5936

Here the first version of my script:

[shell]
#!/bin/bash

TARGET=$1
PACKAGE=$2

if [[ $PACKAGE == "" ]]
then
	echo "Usage: mvpkg Target Package"
	echo "      Target must be like 'volumex' where x is a numeric."
	echo "       Package must be the name of a package."
	exit
fi

if [[ $TARGET != volume[0-9]* ]]
then
	echo "Usage: mvpkg Target Package"
	echo "       Target must be like 'volumex' where x is a numeric."
	echo "       Package [$PACKAGE] must be the name of a package."
	exit
fi

#Check the package and check the result: "enable" (is start), "disable" (is stop) or "does not exist"
output=$(/usr/syno/sbin/synoservicecfg --status "pkgctl-$PACKAGE" | grep Service)

if [[ $output == *"does not exist"* ]]
then
	echo "The service $PACKAGE can't be found."
	exit
else
	#find the current volume of the package and its link
	output=$( ls -la /var/packages/*/target | grep "/$PACKAGE/")

	link=$(echo $output | grep -oP "\/var/packages/.*/target"
	volume=$(echo $output | grep -oP "volume\d*")
	path=$(echo $output | grep -oP "\/volume.*")

	if [[ $link != "/var/packages/$PACKAGE/target"* ]]
	then
		echo "The service $PACKAGE is not correctly installed."
		exit
	fi

	if [[ $volume != "volume" ]]
	then
		echo "The service $PACKAGE can't be located."
		exit
	fi

	if [[ $volume == $TARGET ]]
	then
		echo "he service $PACKAGE is already on $TARGET."
		exit
	fi

	if [[ "$path" != "/$volume/@appstore/$PACKAGE" ]]
	then
		echo "The service $PACKAGE does not have a standard location."
		exit
	fi

	#List Packages with dependency on this one
	#/usr/syno/sbin/synoservicecfg --reverse-dependency pkgctl-$PACKAGE

	#Stop the package and all its dependencies
	output=$(/usr/syno/sbin/synoservicecfg --hard-stop "kgctl-$PACKAGE" | grep warn)

	if [[ $output != *"have been set"* ]]
	then
		echo "The service $PACKAGE couldn't be stopped."
		exit
	fi

	if [ -d "/$TARGET/@appstore/$PACKAGE" ]; then
		mv "/$TARGET/@appstore/$PACKAGE" "/$TARGET/@appstore/$PACKAGE-$(date -d "today" +"%Y%m%d%H%M").log"
	fi

	#remove the link on the previous volume
	rm -f "$link"

	#move the package
	mv "$path" /$TARGET/@appstore

	#link with the  package on the new volume
	ln -s "/$TARGET/@appstore/$PACKAGE" "$link"

	#Replace link also in local
	local="/usr/local/$PACKAGE"
	if [ -L "$local" ]; then
		rm -f "$local"
		ln -s "/$TARGET/@appstore/$PACKAGE" "$local"
	fi

	#update settings
	sed -i "s/$volume/$TARGET/" "/usr/syno/etc/packages/$PACKAGE/*" > /dev/null

	if [[ $output != *"is enabled"* ]]
	then
		echo "The service $PACKAGE didn't restart properly once moved from $volume to $TARGET."
	else
		echo "The service $PACKAGE has been moved successfuly from $volume to $TARGET."

		#Restart packages depending on the one moved
		output=$(/usr/syno/sbin/synoservicecfg --reverse-dependency "pkgctl-$PACKAGE")

		output=$(echo $output | grep -Po "pkgctl-([^\]]*)")
		for string in $output
		do
			/usr/syno/sbin/synoservicecfg --start $string"
		done
	fi	

	#Restart the package and all its dependencies
	output=$(/usr/syno/sbin/synoservicecfg --hard-start "pkgctl-$PACKAGE" | grep Service)

	#Check if the package has been correctly restarted
	output=$(/usr/syno/sbin/synoservicecfg --is-enabled "pkgctl-$PACKAGE")
fi
[/shell]

It is inspired from this post.

I did use it to move: AudioStation, CloudStation, DNSServer, NoteStation, PHP5.6, PHP7.0.

During the move, the package could temporary appear in the Package Center as needing to be repaired:

Simply wait until the operation is completed and click next on “Refresh” in Package Center. Also, check that no other service was stopped but not restarted !! Restarting other services with dependency is not (yet) managed by the script.

WARNING: Moving some packages resulted in troubles (Packages never able to restart). Ex.: Apache Http Server 2.2 and 2.4, the Node.js, Unofficial Java Installer, WordPress. These packages did not restart properly after being moved. I still have to investigate why, but they displayed the error “failed to run the package service” for ever (even after restarting the NAS). Something I known is that there are also Symlinks onto packages in /usr/local/. My script takes those into account. But there are possibly other such dependencies somewhere else ?! Most package could fortunately be returned in their orignal state very easily by moving them back to their original volume.

Important notice

MariaDB. Before moving it, open it via the DSM main menu and change the volume where the DB files are stored.

If you wonder which package is on which volume, the easiest is to run this command in a shell: ls -la /var/packages/*/target

Troubleshooting

WordPress. After moving, it was stuck in the “repair state”. I simply backuped its folder (/volumex/web/wordpress => /volumex/web/wordpress.bkp), clicked on Repair, reconfigured it to use a new DB, stopped it once fully reinstalled, deleted its new folder and replaced it with the backup (/volumex/web/wordpress.bkp => /volumex/web/wordpress) before restarting wordpress and deleting the new DB.

Node.js, FileBot-Node and the Unofficial Java Installer. I simply clicked on Repair to fix them.

Plex Media Server. during y first attempts, it didn’t restart. I did simply install manually the latest version and the “update” fixed the problem without loosing any setting/library/etc… With the latest version of my script, the move succeeded.

Can’t restart. Look into Package’s installation path, for config files possibly still pointing at the old volume. Use for this purpose a command like:  find -L /var/packages/<package_name>/ -type f -print0 | xargs -I {} -0 grep -l “volumex” “{}”

If you find such config files, possibly update them by replacing the old volume (volumex) with the new volume (volumez) using a command like: sed -i “s/volumex/volumez/” <config_file_path>

Stuck ? If you can’t stop/restart a service correctly and can update this one manually, then delete it via a console, Click next Refresh in the Package Center and reinstall it:

• ls -la /var/packages/<package_name>/target   => this is showing you the volume<x> where it’s installed
• rm -R /var/packages/<package_name>
• rm -R /usr/syno/etc/packages/<package_name>
• rm -R /volume<x>/@appstore/<package_name>
• rm -f /usr/syno/synoman/webman/3rdparty/<package_name>
• rm -f /usr/local/<package_name>

Script & Package

I did create a “Synology Package” to be able to move packages easily from the DSM. You can find it on my own Synology Repository (See Blog’s menu “SPK Server”). You will find the script in the Package if you “unzip” it, in \package\ui\mvpkg.sh

[EDIT 13-10-2017] I have added support in the package to start/stop/delete packages, display reverse and forward dependencies. Only delete a packages if you are screwed.

[EDIT 24-02-2018] The sources for my package are available on GitHub (named Package Manager).

[EDIT 23-12-2018] Since a recent update of DSM, the feature to list dependencies between packages does not work anymore.

Once the update started, the progress eventually appeared stuck…

After 2 hours, I decided to open the admin interface (http://<MySyno>:<adminPort>) and was able to log in. But back into the Control Panel, I saw the message “DSM updating is in process…”…

It would not have been a big issue if it didn’t prevent me to update any packages. Trying to do so was resulting in a popup blocking any automatique on manual installation/update. I was also unable to restart or shutdown properly the NAS for the same reason.

To solve this situation I had to kill the upgrade process:

1. Open a SSH console using Putty to connect onto the NAS
2. Login as administrator
3. Enter the root mode using the command: sudo -i
4. Kill the update processes typing the command: kill -9 $(ps aux | grep -e SYNO.Core.Ugrade |grep -v grep | awk ‘{ print $2 }’)

I was next able to update other packages… I did next restart the NAS but for some reasons, it never rebooted completed (neither detected by the Synology Assistant nor accessible via the Admin webUI). I had therefore to do a hard reboot 🙁

Now, although I am still unable to reboot properly or upgrade DSM, I can at least install (or update) packages, possibly to help me in backuping everything before a complete reset.

NB.: I also tried to upgrade from SSH, without success.

Using the feature auto, I got an error message:

Using an explicit download or the explicit path of the patch auto-downloaded, I get no error:

Fortunatelly, in all cases, the DSM is not suck in “updating in process”