From 17a3a91f1edd02a58fd2c1ff147a0ca5bfc31988 Mon Sep 17 00:00:00 2001 From: bryan Date: Thu, 22 Aug 2024 16:04:59 -0400 Subject: [PATCH] Cleanup MC_REPO code --- README.bbcode | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++ installJRMC | 42 ++++++++--------- 2 files changed, 148 insertions(+), 22 deletions(-) create mode 100644 README.bbcode diff --git a/README.bbcode b/README.bbcode new file mode 100644 index 0000000..160b2ef --- /dev/null +++ b/README.bbcode @@ -0,0 +1,128 @@ +[size=20pt]installJRMC[/size] + +This program will install [url=https://www.jriver.com/]JRiver Media Center[/url] and associated services on most major Linux distros. + +You can always find the latest version of installJRMC, changelog, and documentation in [url=https://git.bryanroessler.com/bryan/installJRMC]my repository[/url]. + +[size=18pt]tl;dr One-line MC install[/size] +[code]curl https://git.bryanroessler.com/bryan/installJRMC/raw/master/installJRMC|bash[/code] + +[size=18pt]Instructions[/size] + +Download and unzip installJRMC from the attachment below or grab the latest stable version directly: +[code]curl -O https://git.bryanroessler.com/bryan/installJRMC/raw/master/installJRMC && +chmod +x ./installJRMC && +./installJRMC [--option [ARGUMENT]][/code] + +Running `installJRMC` without any options will install the latest version of JRiver Media Center from the official JRiver repository (Ubuntu/Debian) or my [url=https://repos.bryanroessler.com/jriver/]unofficial repository[/url] (Fedora/CentOS) using the system package manager ([i]i.e.[/i] --install repo). If any other option is passed, then the install method (--install repo or --install local) must be specified, to make it possible to install services and containers independent of MC. + +[size=18pt]Options[/size] + +[code] +$ installJRMC --help +--install, -i repo|local + repo: Install MC from repository, future updates will be handled by the system package manager + local: Build and install MC package from official source package +--build[=suse|fedora|centos] + Build RPM from source DEB but do not install + Optionally, specify a target distro for cross-building (ex. --build=suse, note the '=') +--compat + Build/install MC without minimum dependency version requirements +--mcversion VERSION + Build or install a specific MC version, ex. "33.0.13" +--arch ARCH + Specify the MC architecture, ex. "amd64", "arm64", etc (default: host architecture) +--mcrepo REPO + Specify the MC repository, ex. "bullseye", "bookworm", "noble", etc (default: latest official) +--outputdir PATH + Generate rpmbuild output in this PATH (default: ./output) +--restorefile RESTOREFILE + Restore file location for automatic license registration +--betapass PASSWORD + Enter beta team password for access to beta builds +--service, -s SERVICE + See SERVICES section below for the list of services to deploy + --service-type user|system + Starts services at boot (system) or user login (user) (default: per-service, see SERVICES) +--container, -c CONTAINER (TODO: Under construction) + See CONTAINERS section below for a list of containers to deploy +--createrepo[=suse|fedora|centos] + Build rpm, copy to webroot, and run createrepo. + Optionally, specify a target distro for non-native repo (ex. --createrepo=fedora, note the '=') + --createrepo-webroot PATH + The webroot directory to install the repo (default: /var/www/jriver/) + --createrepo-user USER + The web server user if different from the current user +--yes, -y, --auto + Always assumes yes for questions +--version, -v + Print this script version and exit +--debug, -d + Print debug output +--help, -h + Print help dialog and exit +--uninstall, -u + Uninstall JRiver MC, service files, and firewall rules (does not remove library or media files) +[/code] + +[size=18pt]Services[/size] + +[code]jriver-mediaserver (user) + Enable and start a mediaserver systemd service (requires an existing X server) +jriver-mediacenter (user) + Enable and start a mediacenter systemd service (requires an existing X server) +jriver-x11vnc (user) + Enable and start x11vnc for the local desktop (requires an existing X server, does NOT support Wayland) + --vncpass and --display are also valid options (see below) +jriver-xvnc (system) + Enable and start a new Xvnc session running JRiver Media Center + --vncpass PASSWORD + Set vnc password for x11vnc/Xvnc access. If no password is set, the script will either use existing password stored in ~/.vnc/jrmc_passwd or use no password + --display DISPLAY + Manually specify display to use for x11vnc/Xvnc (ex. ':1') +jriver-createrepo (system) + Install hourly service to build latest MC RPM and run createrepo + By default installs as root service to handle www permissions more gracefully +[/code] + +By default, MC services use a sane `--service-type` listed next to the service name in the Services description. User services can be manipulated as an unprivileged user, for example: [i]systemctl --user stop jriver-mediacenter[/i] and begin at user login. System services are manipulable as root, for example: [i]sudo systemctl stop jriver-servicename@username.service[/i] and begin at system boot. Note that it is possible to run all services of a particular user at boot using [url=https://www.freedesktop.org/software/systemd/man/loginctl.html]sudo loginctl enable-linger username[/url]. + +Multiple services (but not --service-types) can be installed at one time using multiple --service blocks: [code]installJRMC --install repo --service jriver-x11vnc --service jriver-mediacenter[/code] + +[size=14pt]jriver-x11vnc versus jriver-xvnc[/size] + +[url=http://www.karlrunge.com/x11vnc/]jriver-x11vnc[/url] shares your existing X display via VNC and can be combined with additional services to start Media Center or Media Server. Conversely, [url=https://tigervnc.org/doc/Xvnc.html]jriver-xvnc[/url] creates a new Xvnc display and starts a JRiver Media Center service in the foreground of the new VNC display. + +[size=18pt]Containers[/size] + +[b]Coming soon![/b] + +[size=18pt]Firewall[/size] + +`installJRMC` automatically creates port forwarding firewall rules for remote access to Media Network (52100-52200/tcp, 1900/udp DLNA) and Xvnc/x11vnc (if selected), using `firewall-cmd` or `ufw`. +[b]Note:[/b] `ufw` is not installed by default on Debian but will be installed by `installJRMC`. To prevent SSH lock-out, Debian users that have not already enabled `ufw` will need to `sudo ufw enable` after running `installJRMC` and inspecting their configuration. + +[size=18pt]Examples[/size] + +[code]installJRMC[/code] +Install the latest version of MC from the best available repository. +[code]installJRMC --install local --compat[/code] +Install a more widely-compatible version of the latest MC version. +[code]installJRMC --install repo --service jriver-mediacenter --service-type user[/code] +Install MC from the repository and start/enable jriver-mediacenter.service as a user service. +[code]installJRMC --install local --compat --restorefile /path/to/license.mjr --mcversion 33.0.13[/code] +Build and install an MC 33.0.13 comptability RPM locally and activate it using the /path/to/license.mjr +[code]installJRMC --createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user[/code] +Build an RPM locally for the current distro, move it to the webroot, and run createrepo as www-user. +[code]installJRMC --service jriver-createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user[/code] +Install the jriver-createrepo timer and service to build the RPM, move it to the webroot, and run createrepo as www-user hourly. +[code]installJRMC --install repo --service jriver-x11vnc --service jriver-mediacenter --vncpass "letmein"[/code] +Install services to share the existing local desktop via VNC and automatically run MC on startup. +[code]installJRMC --install repo --service jriver-xvnc --display ":2"[/code] +Install an Xvnc server on display ':2' that starts MC. +[code]installJRMC --uninstall[/code] +Uninstall MC, services, and firewall rules. This will [b]not[/b] remove your media, media library/database, or library backup folder. + +[size=18pt]Additional Info[/size] + +Did you find installJRMC useful? [url=https://paypal.me/bryanroessler?locale.x=en_US]Buy me a coffee![/url] \ No newline at end of file diff --git a/installJRMC b/installJRMC index 6eb2d2d..2dbbe4d 100755 --- a/installJRMC +++ b/installJRMC @@ -19,7 +19,7 @@ shopt -s extglob declare -g SCRIPTVERSION="1.2.0" declare -g BOARDURL="https://yabb.jriver.com/interact/index.php/board,86.0.html" # MC33 declare -g MC_VERSION="33.0.13" # Do find all replace -declare -g MC_REPO="bullseye" # should match the MC_VERSION +declare -g MC_DEFAULT_REPO="bullseye" # should match the MC_VERSION printHelp() { debug "Running: ${FUNCNAME[0]}" @@ -178,7 +178,7 @@ init() { ID="ubuntu" if [[ ${VERSION_ID%.*} -ge 24 ]]; then debug "Switching to noble repo for *buntu 24" - declare -g USER_MC_REPO='noble' # Pretend to be user input + declare -g MC_DEFAULT_REPO='noble' fi ;; *suse*) @@ -335,7 +335,7 @@ parseInput() { ARCH="$1" ;; --mcrepo) - shift && declare -g USER_MC_REPO="$1" + shift && declare -g MC_REPO="$1" ;; --restorefile) shift && RESTOREFILE="$1" @@ -428,7 +428,7 @@ setMCVersion() { buildah run "$cnt" -- sh -c \ "apk add apt" &>/dev/null && buildah run "$cnt" -- sh -c \ - "echo 'deb [trusted=no arch=amd64,i386,armhf,arm64] http://dist.jriver.com/latest/mediacenter/ $MC_REPO main' > /etc/apt/sources.list 2>&1" &>/dev/null && + "echo 'deb [trusted=no arch=amd64,i386,armhf,arm64] http://dist.jriver.com/latest/mediacenter/ ${MC_REPO:-$MC_DEFAULT_REPO} main' > /etc/apt/sources.list 2>&1" &>/dev/null && # we are only using this to parse the repo so just use the default buildah run "$cnt" -- sh -c \ "apt update --allow-insecure-repositories &>/dev/null" &>/dev/null && MC_VERSION=$(buildah run "$cnt" -- apt-cache policy mediacenter?? | grep Candidate | awk '{print $2}' | sort -V | tail -n1) &>/dev/null && @@ -449,21 +449,19 @@ setMCVersion() { # Set major version var MC_MVERSION="${MC_VERSION%%.*}" - # Set legacy MC repos based on the major version number + # Set legacy MC repos automatically based on the major version number (if not passed by --mcrepo) # Users can override with --mcrepo - if [[ -z $USER_MC_REPO ]]; then - case $MC_MVERSION in - 2[0-6]) - MC_REPO="jessie" - ;; - 2[7-9]|30) - MC_REPO="buster" - ;; - 3[1-3]) - MC_REPO="bullseye" - ;; - esac - fi + case $MC_MVERSION in + 2[0-6]) + MC_DEFAULT_REPO="jessie" + ;; + 2[7-9]|30) + MC_DEFAULT_REPO="buster" + ;; + 3[1-3]) + MC_DEFAULT_REPO="bullseye" + ;; + esac MC_PKG="mediacenter$MC_MVERSION" MC_RPM="$OUTPUTDIR/RPMS/x86_64/mediacenter$MC_MVERSION-$MC_VERSION.x86_64.rpm" @@ -483,10 +481,10 @@ setMCVersion() { esac fi - echo "Using the $MC_REPO repository" - echo "Using MC version $MC_VERSION from the $MC_REPO repo determined by $MC_VERSION_SOURCE" + echo "Using the ${MC_REPO:-$MC_DEFAULT_REPO} repository" + echo "Using MC version $MC_VERSION from the ${MC_REPO:-$MC_DEFAULT_REPO} repo determined by $MC_VERSION_SOURCE" [[ $MC_VERSION_SOURCE == "user input" ]] || echo "To override, use --mcversion" - debug "MC_VERSION=$MC_VERSION, MC_REPO=$MC_REPO, MC_PKG=$MC_PKG, MC_RPM=$MC_RPM" + debug "MC_VERSION=$MC_VERSION, MC_REPO=${MC_REPO:-$MC_DEFAULT_REPO}, MC_PKG=$MC_PKG, MC_RPM=$MC_RPM" } @@ -652,7 +650,7 @@ installMCFromRepo() { execute sudo rm -rf "$repo_dir"/mediacenter*.list installPackage wget sudo bash -c "cat <<-EOF > $repo_dir/jriver.list - deb [trusted=yes arch=amd64,i386,armhf,arm64] http://dist.jriver.com/latest/mediacenter/ $MC_REPO main + deb [trusted=yes arch=amd64,i386,armhf,arm64] http://dist.jriver.com/latest/mediacenter/ ${MC_REPO:-$MC_DEFAULT_REPO} main EOF" wget -qO- "http://dist.jriver.com/mediacenter@jriver.com.gpg.key" | sudo tee /etc/apt/trusted.gpg.d/jriver.asc &>/dev/null