2 Commits

Author SHA1 Message Date
e7cc7d1232 debug version, do not use 2020-04-26 16:20:44 -04:00
18adf518f2 Update README 2020-04-26 16:20:28 -04:00
2 changed files with 178 additions and 157 deletions

View File

@@ -5,7 +5,8 @@ This script will help install [JRiver Media Center](https://www.jriver.com/) and
## Notes
1. This script will not point major upgrades (i.e. from v25 to v26) to your old library. You should **first perform a library backup**, install the new major version, and then restore the library backup in the new version.
2. It is recommended to run `installJRMC` as your normal system user (i.e. don't run it with `sudo`). Services are installed for the user that executes the script so do not execute as root unless you want to install system-wide services like `createrepo` (see services section below for more information).
2. In **most** cases `installJRMC` should be **executed as your normal user** (i.e. don't run it with `sudo`). Services are installed for the user that executes the script so do not execute as root unless you want to install system-wide services like `createrepo` (see services section below for more information). Doing so may lead to permissions issues.
3. I do my best to test on Fedora/CentOS/Ubuntu/Debian but there are a lot of quirks to support
## Options
@@ -18,7 +19,7 @@ Here is a list of additional options that can be passed to the script. You can a
DEB-based OSes: Official package repository
RPM-based OSes: BryanC unofficial repository
--install-rpmbuild
(RPM-based OSes only!) Build RPM from source DEB and install it
(RPM-based OSes only) Build RPM from source DEB and install it
--rpmbuild
Build RPM from source DEB
--outputdir PATH
@@ -29,6 +30,8 @@ Here is a list of additional options that can be passed to the script. You can a
Restore file location for registration (Default: skip registration)
--betapass PASSWORD
Enter beta team password for access to beta builds
--service-user USER
Install systemd services and containers for USER
--service, -s SERVICE
See SERVICES section below for a list of possible services to install
--container, -c CONTAINER
@@ -50,7 +53,7 @@ Here is a list of additional options that can be passed to the script. You can a
--uninstall, -u
Uninstall JRiver MC, cleanup service files, and remove firewall rules (does not remove library files)
```
**Some options are incompatible** with each other, for example it is not possible to install the `mediaserver` service on Ubuntu/Debian when using `--rpmbuild` or `--createrepo` since those options do not actually install Media Center. `installJRMC` does perform sanity checks to automatically fix conflicting options, but it may not catch all edge cases.
**Some options are incompatible**, for example it is not possible to install the `mediaserver` service on Ubuntu/Debian when using `--rpmbuild` or `--createrepo` since those options do not actually install Media Center. `installJRMC` does perform sanity checks to automatically fix conflicting options, but it may not catch all edge cases.
@@ -59,21 +62,22 @@ When installing systemd services it is important to execute `installJRMC` as the
It is possible to specify multiple services: `installJRMC --service x11vnc --service mediacenter`
```text
mediaserver
jriver-mediaserver
Enable and start a mediaserver systemd service (requires an existing X server)
mediacenter
jriver-mediacenter
Enable and start a mediacenter systemd service (requires an existing X server)
x11vnc
jriver-x11vnc
Enable and start x11vnc for the local desktop (requires an existing X server)
--vncpass and --display are also valid options (see below)
mediacenter-vncserver
jriver-vnc-mediacenter
Enable and start a vncserver running JRiver Media Center
--vncpass PASSWORD
Set vnc password for x11vnc access. If no password is set, the script will either
use existing password stored in ~/.vnc/jrmc_passwd or use no password
Set vnc password for x11vnc/vncserver access. If no password is set, the script
will either use existing password stored in ~/.vnc/jrmc_passwd or use no password
--display DISPLAY
Display to start vncserver/x11vnc (Default: The current display (x11vnc) or next available display (vncserver))
createrepo
Display to start vncserver/x11vnc (Default: The current display (x11vnc) or next
available display (vncserver))
jriver-createrepo
Install hourly service to build latest MC RPM and run createrepo
```
@@ -87,7 +91,7 @@ createrepo
Installs the latest version of JRiver Media Center from the repository.
* `installJRMC --install-repo --service mediaserver`
* `installJRMC --install-repo --service jriver-mediaserver`
Installs JRiver Media Center from the repository and starts/enables the mediaserver service.
@@ -99,20 +103,21 @@ createrepo
Builds the RPM, moves it to the webroot, and runs createrepo as `www-user`.
* `installJRMC --service createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user`
* `installJRMC --service jriver-createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user`
Installs the jriver-createrepo timer and service to build the RPM, move it to the webroot, and run createrepo as `www-user`.
Installs the jriver-createrepo timer and service to build the RPM, move it to the webroot, and runs createrepo as `www-user`.
* `installJRMC --install-repo --service x11vnc --service mediacenter --vncpass "letmein"`
* `installJRMC --install-repo --service jriver-x11vnc --service jriver-mediacenter --vncpass "letmein"`
Installs services to share the existing local desktop via VNC and automatically run Media Center
Installs services to share the existing local desktop via VNC and automatically run Media Center.
* `installJRMC --install-repo --service mediacenter-vncserver --vncpass "letmein"`
* `installJRMC --install-repo --service jriver-vnc-mediacenter`
Installs a service that starts a vncserver containing Media Center
Installs a service that starts a vncserver containing Media Center.
* `installJRMC --uninstall`
Uninstalls JRiver Media Center and its associated services and firewall rules. This will **not** remove your media library and database in case you want to reinstall.
### Donations
Did you find `installJRMC` useful? [Buy me a coffee!](https://paypal.me/bryanroessler?locale.x=en_US)

View File

@@ -20,13 +20,12 @@ shopt -s extglob
#######################################
installJRMC() {
_scriptversion="0.3"
_scriptversion="0.4"
_boardurl="https://yabb.jriver.com/interact/index.php/board,64.0.html"
_outputdir="$_basedir/output"
_createrepo_webroot="/srv/jriver"
_createrepo_user="$(whoami)"
_user="$(whoami)"
_available_services=("createrepo" "x11vnc" "mediaserver" "mediacenter" "mediacenter-vncserver")
_exec_user="$(whoami)"
_available_services=("jriver-createrepo" "jriver-x11vnc" "jriver-mediaserver" "jriver-mediacenter" "jriver-vnc-mediacenter")
#_available_containers=("mediacenter-vncserver" "createrepo")
@@ -55,6 +54,8 @@ OPTIONS
Restore file location for registration (Default: skip registration)
--betapass PASSWORD
Enter beta team password for access to beta builds
--service-user USER
Install systemd services and containers for USER
--service, -s SERVICE
See SERVICES section below for a list of possible services to install
--container, -c CONTAINER
@@ -77,21 +78,22 @@ OPTIONS
Uninstall JRiver MC, cleanup service files, and remove firewall rules (does not remove library files)
SERVICES
mediaserver
jriver-mediaserver
Enable and start a mediaserver systemd service (requires an existing X server)
mediacenter
jriver-mediacenter
Enable and start a mediacenter systemd service (requires an existing X server)
x11vnc
jriver-x11vnc
Enable and start x11vnc for the local desktop (requires an existing X server)
--vncpass and --display are also valid options (see below)
mediacenter-vncserver
jriver-vnc-mediacenter
Enable and start a vncserver running JRiver Media Center
--vncpass PASSWORD
Set vnc password for x11vnc access. If no password is set, the script will either
use existing password stored in ~/.vnc/jrmc_passwd or use no password
Set vnc password for x11vnc/vncserver access. If no password is set, the script
will either use existing password stored in ~/.vnc/jrmc_passwd or use no password
--display DISPLAY
Display to start vncserver/x11vnc (Default: The current display (x11vnc) or next available display (vncserver))
createrepo
Display to start vncserver/x11vnc (Default: The current display (x11vnc) or next
available display (vncserver))
jriver-createrepo
Install hourly service to build latest MC RPM and run createrepo
CONTAINERS
@@ -114,7 +116,7 @@ EOF
return 1
fi
if _input=$(getopt -o +vdhus:c: -l install-repo,install-rpmbuild,rpmbuild,outputdir:,mcversion:,restorefile:,betapass:,service:,version,debug,force,help,uninstall,createrepo,createrepo-webroot:,createrepo-user:,vncpass:,display:,container: -- "$@"); then
if _input=$(getopt -o +vdhus:c: -l install-repo,install-rpmbuild,rpmbuild,outputdir:,mcversion:,restorefile:,betapass:,service-user:,service:,version,debug,force,help,uninstall,createrepo,createrepo-webroot:,createrepo-user:,vncpass:,display:,container: -- "$@"); then
eval set -- "$_input"
while true; do
case "$1" in
@@ -140,6 +142,9 @@ EOF
--betapass)
shift && _betapass="$1"
;;
--service-user)
shift && _service_user="$1"
;;
--service|-s)
shift && _services+=("$1")
;;
@@ -209,11 +214,13 @@ EOF
#######################################
# Prepend this to any command that you wish to execute with sudo (i.e. when _user is NOT root)
# Prepend this to any command that you wish to execute with sudo
# Requires:
# _exec_user
#######################################
_ifSudo() {
if [[ "$_user" != "root" ]]; then
if [[ "$_exec_user" != "root" ]]; then
sudo "$@"
else
"$@"
@@ -221,25 +228,6 @@ EOF
}
_checkUser() {
_runDebug "${FUNCNAME[0]}"
if [[ "$_user" == "root" ]]; then
cat <<EOF
Warning! You are currently running installJRMC as the root user. This is not recommended! When
running as a regular user, installJRMC will ask you for your sudo password when necessary.
Installation will continue but any systemd services will be installed as system services and you
may run into permissions issues.
EOF
else
[[ -n $_debug ]] && echo "Installing as user: $_user"
fi
}
#######################################
# Sources /etc/os-release so we know which OS we're running on
# Used in: _buildCommands()
@@ -248,8 +236,8 @@ EOF
_runDebug "${FUNCNAME[0]}"
if [[ -e /etc/os-release ]]; then
source /etc/os-release
if [[ -e "/etc/os-release" ]]; then
source "/etc/os-release"
else
err "No /etc/os-release found"
err "Your OS is unsupported"
@@ -337,8 +325,8 @@ EOF
else
_createrepo_cmd(){ sudo -u "$_createrepo_user" createrepo -q "$@"; }
fi
_mkdir_cmd(){ sudo -u "$_createrepo_user" mkdir -p "$@"; }
_cp_cmd(){ sudo -u "$_createrepo_user" cp -n "$@"; }
_cr_mkdir_cmd(){ sudo -u "$_createrepo_user" mkdir -p "$@"; }
_cr_cp_cmd(){ sudo -u "$_createrepo_user" cp -n "$@"; }
else
if [[ -d "$_createrepo_webroot/repodata" ]]; then
_createrepo_cmd(){ createrepo -q --update "$@"; }
@@ -350,6 +338,21 @@ EOF
}
#######################################
# Sets default user variables
# Requires:
# _exec_user
# Globals
# _service_user
# _createrepo_user
#######################################
_setUser() {
[[ -z $_service_user ]] && _service_user="$_exec_user"
[[ -z $_createrepo_user ]] && _createrepo_user="$_exec_user"
}
#######################################
# Installs a package using the system package manager
# Arguments:
@@ -545,6 +548,9 @@ EOF
# Check for bad service name
#
_checkServices() {
_runDebug "${FUNCNAME[0]}"
for _service in "${_services[@]}"; do
if ! _inArray "$_service" "${_available_services[@]}"; then
echo "Incorrect service type provided"
@@ -554,33 +560,43 @@ EOF
}
_createrepoBuild() {
if _inArray "createrepo" "${_services[@]}"; then
echo "Incorrect service type provided"
_printHelpAndExit 1
fi
}
_checkMCInstalled() {
_runDebug "${FUNCNAME[0]}"
if [[ "${_services[*]}" =~ ^(mediacenter|mediaserver|mediacenter-vncserver)$ ]]; then
if [[ -z $_repoinstall && -z $_rpminstall ]]; then
if [[ -x $(command -v "mediacenter$_mversion") ]]; then
err "You are attempting to install a service that relies on mediacenter$_mversion but --install-repo/--install-rpmbuild are not set and mediacenter$_mversion is not installed"
_printHelpAndExit 1
return 1
fi
fi
fi
}
_checkUser() {
_runDebug "${FUNCNAME[0]}"
if [[ "$_exec_user" == "root" && -z "$_service_user" && "${_services[*]}" ]]; then
err "Attempting to install services as the root user"
err "This is not recommended and we are exiting now to prevent permission hell"
err "You can override this safety check by manually specifying --user root"
return 1
fi
}
# Enable/disable sanity checks
_checkServices
_checkMCInstalled
#_createrepoBuild
if _checkServices && _checkMCInstalled && _checkUser; then
[[ -n $_debug ]] && echo "Sanity checks passed!"
return 0
else
err "Sanity checks failed!"
exit 1
fi
}
@@ -822,7 +838,7 @@ EOF"
# If the webroot does not exist, create it
if [[ ! -d "$_createrepo_webroot" ]]; then
if ! _mkdir_cmd "$_createrepo_webroot"; then
if ! _cr_mkdir_cmd "$_createrepo_webroot"; then
err "Could not create the createrepo-webroot path!"
err "Make sure that the createrepo-webroot is writeable by createrepo-user"
return 1
@@ -830,7 +846,7 @@ EOF"
fi
# Copy built rpms to webroot
if ! _cp_cmd "$_rpmfile" "$_createrepo_webroot"; then
if ! _cr_cp_cmd "$_rpmfile" "$_createrepo_webroot"; then
err "Could not copy the RPM to the createrepo-webroot path"
err "Make sure that the createrepo-webroot path is writeable by createrepo-user"
return 1
@@ -924,6 +940,9 @@ EOF"
elif [[ "$1" =~ ^(x11vnc|vncserver)$ ]]; then
_f_ports=("$_port/tcp")
_u_ports="$_port/tcp"
else
err "_openFirewall unrecognized service name"
exit 1
fi
# Open the ports
@@ -1031,23 +1050,59 @@ EOF"
#######################################
# Create associated service variables based on service name
# Set display and port variables
# Arguments:
# Requires exactly one argument, the name of the service to parse
# One optional integer argument to increment _service_display by
# Globals:
# _service_display
# _service_displaynum
# _port
#######################################
_setDisplayandPort() {
declare -g _service_display
declare -g _service_displaynum
declare -g _port
if [[ -n $_display ]]; then
_service_display="$_display"
elif [[ -n $DISPLAY ]]; then
_service_displaynum="${DISPLAY#:}" # strip colon
_service_displaynum="${_service_displaynum%.*}" # strip suffix
_service_displaynum=$(( _service_displaynum + "${1:-0}" )) # incr by $1
_service_display=":$_service_displaynum"
else
_service_display=":0"
fi
_port=$(( _service_displaynum + 5900 ))
}
#######################################
# Create associated service variables based on service name
# Requires:
# _service_user
# Globals:
# _service_fname
# _timer_fname
# _service_name
# _timer_name
# _user_specifier
#######################################
_servicePrep() {
if [[ "$_user" == "root" ]]; then
_service_fname="/usr/lib/systemd/system/jriver-${1}.service"
_timer_fname="/usr/lib/systemd/system/jriver-${1}.timer"
if [[ "$_service_user" == "root" ]]; then
_service_fname="/usr/lib/systemd/system/${1}.service"
_timer_fname="/usr/lib/systemd/system/${1}.timer"
_service_name="jriver-${1}.service"
_timer_name="jriver-${1}}.timer"
_user_specifier=""
else
_service_fname="/usr/lib/systemd/system/jriver-${1}@.service"
_timer_fname="/usr/lib/systemd/system/jriver-${1}@.timer"
_service_name="jriver-${1}@$_user.service"
_timer_name="jriver-${1}@$_user.timer"
_service_fname="/usr/lib/systemd/system/${1}@.service"
_timer_fname="/usr/lib/systemd/system/${1}@.timer"
_service_name="${1}@$_service_user.service"
_timer_name="${1}@$_service_user.timer"
_user_specifier="User=%I"
fi
}
@@ -1056,11 +1111,11 @@ EOF"
#######################################
# SERVICES
#######################################
_serviceMediaserver() {
_service_jriver-mediaserver() {
_runDebug "${FUNCNAME[0]}"
[[ -z $_display ]] && _display="${DISPLAY:-":0"}"
_setDisplay
_bash_cmd "cat <<-EOF > $_service_fname
[Unit]
@@ -1083,16 +1138,16 @@ WantedBy=graphical.target
EOF"
_systemctl_reload && \
_systemctl_start "$_service_name" && \
_systemctl_enable "$_service_name"
_systemctl_enable "$_service_name" && \
_openFirewall "jriver"
}
_serviceMediacenter() {
_service_jriver-mediacenter() {
_runDebug "${FUNCNAME[0]}"
# Set the display to use
[[ -z $_display ]] && _display="${DISPLAY:-":0"}"
_setDisplay
_bash_cmd "cat <<-EOF > $_service_fname
[Unit]
@@ -1102,7 +1157,7 @@ After=graphical.target
[Service]
$_user_specifier
Type=simple
Environment=DISPLAY=$_display
Environment=DISPLAY=$_service_display
Environment=XAUTHORITY=$XAUTHORITY
ExecStart=/usr/bin/mediacenter$_mversion
Restart=always
@@ -1115,36 +1170,27 @@ WantedBy=graphical.target
EOF"
_systemctl_reload && \
_systemctl_start "$_service_name" && \
_systemctl_enable "$_service_name"
_systemctl_enable "$_service_name" && \
_openFirewall "jriver"
}
_serviceVNC() {
_service_jriver-vnc-mediacenter() {
_runDebug "${FUNCNAME[0]}"
_installPackage tigervnc-server
_setDisplay 1
_setVNCPass
if [[ -n $_novncauth ]]; then
_exec_start_cmd="/usr/bin/vncserver $_display -geometry 1440x900 -alwaysshared -fg -SecurityTypes None -xstartup /usr/bin/mediacenter$_mversion"
_exec_start_cmd="/usr/bin/vncserver $_service_display -geometry 1440x900 -alwaysshared -fg -SecurityTypes None -xstartup /usr/bin/mediacenter$_mversion"
else
_exec_start_cmd="/usr/bin/vncserver $_display -geometry 1440x900 -alwaysshared -fg -rfbauth $HOME/.vnc/jrmc_passwd -xstartup /usr/bin/mediacenter$_mversion"
_exec_start_cmd="/usr/bin/vncserver $_service_display -geometry 1440x900 -alwaysshared -fg -rfbauth $HOME/.vnc/jrmc_passwd -xstartup /usr/bin/mediacenter$_mversion"
fi
# Set the display to use
if [[ -z $_display ]]; then
# If we are running on existing X server then increment DISPLAY by one
if [[ -n $DISPLAY ]]; then
_display=$(( ${DISPLAY#:} + 1 ))
_display=":$_display"
else
_display=":0"
fi
fi
declare -g _port=$(( ${_display#:} + 5900 ))
declare -g _port=$(( ${_service_display#:} + 5900 ))
_bash_cmd "cat <<-EOF > $_service_fname
[Unit]
@@ -1154,9 +1200,9 @@ After=syslog.target network.target
[Service]
Type=simple
$_user_specifier
ExecStartPre=/bin/sh -c '/usr/bin/vncserver -kill $_display > /dev/null 2>&1 || :'
ExecStartPre=/bin/sh -c '/usr/bin/vncserver -kill $_service_display > /dev/null 2>&1 || :'
ExecStart=$_exec_start_cmd
ExecStop=/usr/bin/vncserver -kill $_display
ExecStop=/usr/bin/vncserver -kill $_service_display
[Install]
WantedBy=multi-user.target
@@ -1164,31 +1210,30 @@ EOF"
_systemctl_reload && \
_systemctl_start "$_service_name" && \
_systemctl_enable "$_service_name" && \
echo "vncserver running on localhost:$_port"
echo "vncserver running on localhost:$_port" && \
_openFirewall "vncserver" && \
_openFirewall "jriver"
}
_serviceX11VNC() {
_service_jriver-x11vnc() {
_runDebug "${FUNCNAME[0]}"
_installPackage x11vnc
_setDisplay
_setX11VNCPass
[[ -z $_display ]] && _display="${DISPLAY:-":0"}"
declare -g _port=$(( ${_display#:} + 5900 ))
# Get current desktop resolution
# TODO: may need to break this out into its own function and get smarter at identifying multi-monitors
local _res
_res=$(xdpyinfo | grep dimensions | awk '{print $2}')
if [[ -n $_novncauth ]]; then
_exec_start_cmd="/usr/bin/x11vnc -display $_display -noscr -geometry $_res -auth guess -forever -bg -nopw"
_exec_start_cmd="/usr/bin/x11vnc -display $_service_display -noscr -geometry $_res -auth guess -forever -bg -nopw"
else
_exec_start_cmd="/usr/bin/x11vnc -display $_display -noscr -geometry $_res -auth guess -forever -bg -rfbauth $HOME/.vnc/jrmc_passwd"
_exec_start_cmd="/usr/bin/x11vnc -display $_service_display -noscr -geometry $_res -auth guess -forever -bg -rfbauth $HOME/.vnc/jrmc_passwd"
fi
_bash_cmd "cat <<-EOF > $_service_fname
@@ -1199,7 +1244,7 @@ After=multi.service
[Service]
$_user_specifier
Type=forking
Environment=DISPLAY=$_display
Environment=DISPLAY=$_service_display
ExecStart=$_exec_start_cmd
Restart=always
RestartSec=10
@@ -1209,12 +1254,13 @@ WantedBy=multi-user.target
EOF"
_systemctl_reload && \
_systemctl_start "$_service_name" && \
_systemctl_enable "$_service_name"
echo "x11vnc running on localhost:$_port"
_systemctl_enable "$_service_name" && \
echo "x11vnc running on localhost:$_port" && \
_openFirewall "x11vnc"
}
_serviceCreaterepo() {
_service_jriver-createrepo() {
_runDebug "${FUNCNAME[0]}"
@@ -1314,21 +1360,21 @@ EOF"
__main() {
# Check user
_checkUser
# Parse input
_parseInput "$@"
# Sanity checks
_sanityChecks
# Set user variables
_setUser
# Build some OS-specific commands based on the selected OS
_buildCommands
# Set version to install/uninstall
_setVersion
# Sanity checks
_sanityChecks
# Uninstall and exit
if [[ -n $_uninstall ]]; then
_uninstall
@@ -1369,42 +1415,12 @@ EOF"
# Install services
for _service in "${_services[@]}"; do
_servicePrep "$_service"
case "$_service" in
createrepo)
_serviceCreaterepo
;;
x11vnc)
_serviceX11VNC
_openFirewall "x11vnc"
;;
mediaserver)
_serviceMediaserver
;;
mediacenter)
_serviceMediacenter
;;
mediacenter-vncserver)
_serviceVNC
_openFirewall "vncserver"
;;
*)
esac
"_service_$_service"
done
# Install containers
for _container in "${_containers[@]}"; do
case "$_container" in
createrepo)
_containerCreaterepo
;;
mediacenter-vncserver)
_containerVNC
;;
mediacenter)
_containerMC
;;
*)
esac
"_container_$_container"
done
}
}