Update plex-core to support synology packages #247

myellen · 2018-11-28T17:55:01Z

Checks DISTRO variable in getPlexVersion and parseVersion to see if script is running on synology.

Fixes #245

demonbane · 2018-12-20T01:59:42Z

Is it even possible to install Plex from the command-line on a Synology NAS? I have one that I've got root SSH access on, but I don't know of any way to install the .spk packages from the command-line.

abl · 2018-12-23T19:09:06Z

@demonbane synopkg install <path to .spk file> as root looks like it does the trick.

demonbane · 2018-12-23T23:48:40Z

That's great! Ok, so this can be added because it is an officially supported platform from Plex, but there are a couple of issues that need to be addressed first. In addition to downloading the Synology package, this should also support:

Installing the package
Starting and stopping the package before/after installation if necessary (I'm not familiar with how synopkg works, so if it already does this automatically then it can be skipped)
Verify that the script is running in a bash 4+ environment. DSM was shipping a 3.x bash version until recently, so some users might still have an old version of bash which won't work.
Any additional logic specific to how Synology handles packages that I haven't listed here.

myellen · 2019-02-09T21:57:46Z

Do you mean installing the package for the first time? or using your plexupdate installer script? It does handle installing the package using manual setup (but the user does have to follow the instructions on this page first to trust plex packages). I haven't modified installer.sh to detect the synology distro, so installer.sh wont work.

synopkg automatically starts and stops the package for installation.

I don't have an older version of dsm to test with. However, the changes I made don't use any bash functions that weren't already present in the script, so I'd assume it works fine in bash 3.x.

demonbane · 2019-02-11T01:50:33Z

I did a bit of digging and it looks like most (all?) versions of DSM 6 already include bash 4 so I think that should be ok. The existing code is already pretty heavily dependent on bash 4 which is why I mentioned it.

For installation, it would be great if you update installer.sh to support initial setup as well, but the only requirement would be that plexupdate can auto-install the update after downloading it (presumably using the synopkg command provided above).

There should also be some logic added to try to determine if we're running on a synology automatically so that it doesn't have to be specified via an environment variable:

plexupdate/plexupdate.sh

Lines 298 to 315 in 293e6d5

    
           if [ -z "${DISTRO_INSTALL}" ]; then 
        
           	if [ -z "${DISTRO}" -a -z "${BUILD}" ]; then 
        
           		# Detect if we're running on redhat instead of ubuntu 
        
           		if [ -f /etc/redhat-release ]; then 
        
           			REDHAT=yes 
        
           			BUILD="linux-ubuntu-${ARCH}" 
        
           			DISTRO="redhat" 
        
           			if ! hash dnf 2>/dev/null; then 
        
           				DISTRO_INSTALL="${REDHAT_INSTALL/dnf/yum}" 
        
           			else 
        
           				DISTRO_INSTALL="${REDHAT_INSTALL}" 
        
           			fi 
        
           		else 
        
           			REDHAT=no 
        
           			BUILD="linux-ubuntu-${ARCH}" 
        
           			DISTRO="ubuntu" 
        
           			DISTRO_INSTALL="${DEBIAN_INSTALL}" 
        
           		fi

I'm excited to see this added, so I'll try to be as responsive as possible to any questions you have so we can get this merged soon. Thanks for working on this!

myellen · 2019-02-12T17:05:35Z

I patched plexupdate.sh to detect synology and to work with the new 5.json naming scheme.

I updated installer.sh too. Where does installer.sh set the BUILD variable? or is it not necessary? I define DISTRO and DISTRO_INSTALL inside of check_distro().

bruvv · 2019-04-16T17:54:40Z

any update on this? I am still receiving an issue: #259

myellen · 2019-04-16T18:29:56Z

@d1slact0r no. you can manually download plexupdate-core and plexupdate.sh from my pull request and replace the versions you have on your synology now

plexupdate.sh

BradleyMarie · 2019-05-30T07:07:10Z

I believe you also need to update the AUTOSTART section to add handling for using synopkg to start the job after the update completes.

demonbane · 2019-05-31T18:07:56Z

This fork is from an older release which still has the old API endpoints and build designations. It should be rebased to the current HEAD from upstream.

checks DISTRO variable in getPlexVersion and parseVersion

change cut to return field 2 and 3 instead of just 2

update plexupdate.sh to automatically determine if we're running on a synology

add ability to detect if running on synology in installer.sh

add spaces before closing brackets

changed spaces to tabs

myellen · 2019-06-05T18:55:43Z

I believe you also need to update the AUTOSTART section to add handling for using synopkg to start the job after the update completes.

It's been working for me without that, but I'll double check

This fork is from an older release which still has the old API endpoints and build designations. It should be rebased to the current HEAD from upstream.

I just rebased it.

remove check for plexpass version as now public versions also use new build versions.

demonbane

This looks pretty good to me. Once the changes are done I'll try installing Plex on my Synology at home so I can test it locally and then we can get it merged upstream. Thanks very much for working on this!

demonbane · 2019-06-05T19:46:08Z

plexupdate-core

@@ -228,13 +228,17 @@ isNewerVersion() {
 parseVersion() {
 	if [ "${REDHAT}" = "yes" ]; then
 		cut -f2- -d- <<< "$1" | cut -f1-4 -d.
+	elif [ "${DISTRO}" = "synology" ]; then
+		cut -f2-3 -d- <<< "$1"
 	else
 		cut -f2 -d_ <<< "$1"
 	fi
 }

 getPlexVersion() {


For readability, functions like these should generally start with the "default" option (Ubuntu/Debian) and then go on to the other cases. It's just a bit confusingly written right now because of how the REDHAT variable is used. I'd suggest swapping the two first cases and adding a comment (which I really should have done when I wrote the function 🤦‍♂ ), about what the "${REDHAT}" != "yes" does.)

The way GitHub is rendering this is a bit confusing. The comment is about the getPlexVersion function, not isNewerVersion.

so if I just switch the cases like so

if [ "${REDHAT}" != "yes" ]; then dpkg-query --showformat='${Version}' --show plexmediaserver 2>/dev/null elif [ "${DISTRO}" = "synology" ]; then synopkg version "Plex Media Server" 2>/dev/null

I don't think the switch ever reaches the synology case because "${REDHAT}" != "yes" is true for synology devices too.

I'm not sure how best to change it.

plexupdate.sh

demonbane · 2019-06-05T20:25:57Z

Now that we're going to have 3 supported platforms, I think it's also time to retire the REDHAT variable altogether as well. If you'd like to take a stab at it I'd really appreciate it, but if not I can try to do it myself later.

BUILD="linux-${ARCH}" is already done at line 56 Co-Authored-By: Alex Malinovich <alexmalinovich@gmail.com>

myellen · 2019-06-06T03:13:06Z

Before you install it on your synology, you'll have to follow the instructions in How to add Plex’s package signing public key to Synology NAS Package Center. That link should be added to the readme or the wiki.

re: redhat, I don't have any linux boxes to test with, and I'm not very familiar with them anyways. So unfortunately, I'm not really comfortable making those changes.

Add link to "How to add Plex’s package signing public key to Synology NAS Package Center"

myellen · 2019-06-06T03:23:26Z

I added it to the README since you need to do that step whether you use automatic or manual setup.

demonbane · 2019-06-06T03:26:42Z

Can the package signing key stuff be done via the command line? That would be a great thing to add to installer.sh.

demonbane · 2019-06-13T21:09:52Z

We could skip that check altogether, but my synology does have an /etc/crontab and /etc/cron.d that should work.

The installer only knows how to put a file into /etc/cron.daily right now anyway (though I am planning support for systemd timers at some point), so I don't think mentioning cron would be useful here.

What I'd love would be if the installer can just create a Task Scheduler task from the command line, but I'm not having much luck in finding a way to do it. synoschedtask seems to only be able to operate on already defined tasks, not set up a new one, and synowebapi could almost certainly do it, but I can't find any public API documentation on the Task Scheduler interface.

That would still be my preferred solution, but if we can't find a way to do it then we can at least print a link to a (soon to be written) wiki article on how to set up a scheduled task on Synology. (just need to short-circuit the logic at the top of configure_cron)

myellen · 2019-06-13T23:31:36Z

The GUI task scheduler just adds the tasks to /etc/crontab using synoschedtask. In my crontab 0 6 * * * root /usr/syno/bin/synoschedtask --run id=16 is the line for plexupdate.

We should be able to add a line to /etc/crontab, link cronwrapper inside of /etc/cron.d, or create a /etc/cron.daily folder to use.

demonbane · 2019-06-14T00:28:47Z

Do you know if cron job output will still get sent to the admin? I have a couple of scheduled tasks on my NAS and when they run I get an HTML email from Synology showing the output which leads me to believe that notifications are handled by synoschedtask, not the usual cron mail configuration.

demonbane · 2019-06-14T00:35:31Z

Oh, and the system crontab has MAILTO="" right at the top, so I guess that answers that question. :)

Ok, so in that case we can still add the job, we just need to provide a warning that on Synology you won't get any output. Any thoughts on a good flow to use in the installer that'll also be portable to other Linux systems that may not use the cron.daily setup?

myellen · 2019-06-14T16:26:59Z

I think if there's no cron.daily, it should check for cron.d. If it finds cron.d, change CRONWRAPPER to /etc/cron.d/plexupdate, then create a crontab file named plexupdate in cron.d with one line that just calls the cronwrapper as a script like 0 6 * * * root /path/to/plexupdate/cronwrapper.

So add some logic around line 235 and around line 277 to check CRONWRAPPER and switch to something like echo "0 6 * * * root ${FULL_PATH}/extras/cronwrapper" > "$CRONWRAPPER"

extras/installer.sh

demonbane · 2019-06-14T23:42:56Z

I agree with everything except:

I think if there's no cron.daily, it should check for cron.d.

At the time, using cron.daily was just the simplest way of implementing this, but if we're going to just use cron.d might as well use it by default and get rid of cron.daily altogether.

Since installer.sh is meant to be run multiple times without problems, there should be some code to migrate an old cron.daily setup to cron.d. (for bonus points, grab the cron.daily time in crontab and use that in the cron.d entry. And if cron.daily/plexupdate isn't a symlink just assume they've got a custom setup and exit the cron logic without any changes/questions)

Use new crontab file file in cron.d instead of cron.daily to support more devices

myellen · 2019-06-19T18:51:48Z

I changed the cron support to use cron.d instead of cron.daily. There's not anything to migrate since it still uses /etc/plexupdate.cron.conf for settings, and that file gets overwritten every time you run installer.sh anyways. But it does remove the old file in cron.daily if its a symlink.

I look for a cron.daily job in crontab for the time, otherwise I just picked 4 am. May be something we prompt the user for.

I'm having some weird trouble with it running though. The cron job runs at the right time, and it does run the cronwrapper, and that does run plexupdate.sh, but it doesn't actually update. However if I manually run cronwrapper, it works fine. Maybe something with permissions or something weird with cron. So I'm curious if it's just my machine it happens on.

myellen · 2019-06-19T18:57:22Z

On second look, it might be because I don't include PATH in the new cron file...

myellen · 2019-06-19T19:20:04Z

yeah, that fixed it. Should be all good now.

Easier to see what /etc/cron.d/plexupdate will look like

AUTOSTART is needed on synology

deepfriedmind · 2019-07-19T17:36:03Z

So, is this about to be merged, or..?

demonbane · 2019-07-19T17:39:56Z

Hopefully late next week. I’ve been traveling the last few weeks and haven’t had a chance to review the latest updates, but it’s on my list as soon as I get back.

deepfriedmind · 2019-10-28T11:02:31Z

I've checked out this pull request and it still seems that PMS isn't started again after an update.

myellen · 2019-11-25T18:11:56Z

@deepfriedmind Which Synology and DSM version are you using? It’s been working for me on a ds916+ and dsm 6.

deepfriedmind · 2019-11-25T19:19:33Z

I'm using a DS916+ on DSM 6.2.2-24922 Update 4.

myellen · 2019-11-26T20:30:31Z

Here are my troubleshooting questions:

Is AUTOSTART=‘yes’ In your configuration file?
Are DISTRO and/or DISTRO_INSTALL already defined in your configuration file?
Does the file /etc/synoinfo.conf exist on your Synology?
What happens if you use ssh and run synopkg start “Plex Media Server”?
Does synopokg list --name show a name for plex different form “Plex Media Server”?

gapple · 2020-12-02T20:47:28Z

I was able to install and configure this branch successfully on a DS418 with DSM 6.2.3-25426 Update 2

gapple · 2021-08-06T18:35:57Z

This no longer appears to work on DSM 7; it looks like there is a new DISTRO: synology-dsm7

bruvv mentioned this pull request Apr 16, 2019

ERROR: Unable to retrieve the URL needed for download (Query DISTRO: synology, BUILD: ) #259

Closed

deepfriedmind reviewed May 9, 2019

View reviewed changes

plexupdate.sh Outdated Show resolved Hide resolved

BradleyMarie reviewed May 30, 2019

View reviewed changes

plexupdate.sh Outdated Show resolved Hide resolved

BradleyMarie reviewed May 30, 2019

View reviewed changes

plexupdate.sh Outdated Show resolved Hide resolved

myellen added 5 commits June 5, 2019 14:39

Update plex-core to support synology packages

9fc45da

checks DISTRO variable in getPlexVersion and parseVersion

include build identifier in FILE_VERSION

117f922

change cut to return field 2 and 3 instead of just 2

detect synology

9124a43

update plexupdate.sh to automatically determine if we're running on a synology

update installer.sh

5bfb7d4

add ability to detect if running on synology in installer.sh

add spaces

a5d183f

add spaces before closing brackets

myellen force-pushed the master branch from 3d93934 to a5d183f Compare June 5, 2019 18:42

indent with tabs instead of spaces

b6fc540

changed spaces to tabs

remove old build values

ec89f90

remove check for plexpass version as now public versions also use new build versions.

demonbane reviewed Jun 5, 2019

View reviewed changes

remove redundant line of code

70888ea

BUILD="linux-${ARCH}" is already done at line 56 Co-Authored-By: Alex Malinovich <alexmalinovich@gmail.com>

Add synology section to readme

1aba28a

Add link to "How to add Plex’s package signing public key to Synology NAS Package Center"

myellen added 2 commits June 14, 2019 11:53

remove color from error message

335cf82

enable AUTOSTART for synology

2c91c80

demonbane reviewed Jun 14, 2019

View reviewed changes

extras/installer.sh Outdated Show resolved Hide resolved

myellen added 3 commits June 14, 2019 21:51

dont repeat code

848f56c

enable AUTODELETE by default

e5b65ce

Update cron support

508e7dd

Use new crontab file file in cron.d instead of cron.daily to support more devices

Add PATH variable to cron file

35fea18

myellen added 5 commits June 19, 2019 15:25

remove duplicated code for saving config

e9cecfc

remove comment

fa31574

Also copy MAILTO from crontab

26c65ff

move around cron file creation

a83f077

Easier to see what /etc/cron.d/plexupdate will look like

suppress AUTOSTART warning for synology

c203795

AUTOSTART is needed on synology

gapple mentioned this pull request Aug 6, 2021

Support for Synology [DSM 7] #291

Open

Update plex-core to support synology packages #247

Are you sure you want to change the base?

Update plex-core to support synology packages #247

Conversation

myellen commented Nov 28, 2018 • edited

demonbane commented Dec 20, 2018

abl commented Dec 23, 2018

demonbane commented Dec 23, 2018

myellen commented Feb 9, 2019 • edited

demonbane commented Feb 11, 2019

myellen commented Feb 12, 2019

bruvv commented Apr 16, 2019 • edited

myellen commented Apr 16, 2019

BradleyMarie commented May 30, 2019

demonbane commented May 31, 2019

myellen commented Jun 5, 2019

demonbane left a comment • edited

Choose a reason for hiding this comment

demonbane Jun 5, 2019

Choose a reason for hiding this comment

demonbane Jun 5, 2019

Choose a reason for hiding this comment

myellen Jun 6, 2019

Choose a reason for hiding this comment

demonbane commented Jun 5, 2019

myellen commented Jun 6, 2019

myellen commented Jun 6, 2019

demonbane commented Jun 6, 2019

demonbane commented Jun 13, 2019

myellen commented Jun 13, 2019

demonbane commented Jun 14, 2019

demonbane commented Jun 14, 2019

myellen commented Jun 14, 2019

demonbane commented Jun 14, 2019

myellen commented Jun 19, 2019

myellen commented Jun 19, 2019

myellen commented Jun 19, 2019

deepfriedmind commented Jul 19, 2019

demonbane commented Jul 19, 2019

deepfriedmind commented Oct 28, 2019

myellen commented Nov 25, 2019

deepfriedmind commented Nov 25, 2019 • edited

myellen commented Nov 26, 2019 • edited

gapple commented Dec 2, 2020

gapple commented Aug 6, 2021

myellen commented Nov 28, 2018 •

edited

myellen commented Feb 9, 2019 •

edited

bruvv commented Apr 16, 2019 •

edited

demonbane left a comment •

edited

deepfriedmind commented Nov 25, 2019 •

edited

myellen commented Nov 26, 2019 •

edited