From 8f3dcd5efd10d4ba6acbb91368623cea53426456 Mon Sep 17 00:00:00 2001 From: bryan Date: Sat, 25 Apr 2020 13:08:15 -0400 Subject: [PATCH] Update README --- README.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 3507de6..4b0e89f 100644 --- a/README.md +++ b/README.md @@ -7,22 +7,6 @@ This script will help install [JRiver Media Center](https://www.jriver.com/) and 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). -## Installing - -1. Extract: -``` -unzip ./installJRMC.zip -``` -2. You may need to make the script executable: -``` -chmod +x ./installJRMC -``` -3. Run the script using default options (see Options section below): -``` -./installJRMC -``` -You will be prompted to enter your sudo password to install dependencies, etc. - ## Options Running `installJRMC` without any options will install the latest version of JRiver Media Center from the official JRiver repository (Ubuntu/Debian) or my unofficial repository (Fedora/CentOS) using the system package manager. @@ -72,6 +56,8 @@ Here is a list of additional options that can be passed to the script. You can a #### services When installing systemd services it is important to execute `installJRMC` as the user you wish to run the services. Typically this is your normal user account but for some server installations it may be necessary to execute the script as root. + +It is possible to specify multiple services: `installJRMC --service x11vnc --service mediacenter` ```text mediaserver Enable and start a mediaserver systemd service (requires an existing X server) @@ -79,19 +65,17 @@ mediacenter Enable and start a mediacenter systemd service (requires an existing X server) x11vnc Enable and start x11vnc for the local desktop (requires an existing X server) - --vncpass and --display are valid options (see below) + --vncpass and --display are also valid options (see below) mediacenter-vncserver - Enable and start a vncserver + 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 --display DISPLAY - Display to start vncserver/x11vnc (Default: The current display or :0 if current display - is unaccessible) + Display to start vncserver/x11vnc (Default: The current display (x11vnc) or next available display (vncserver)) createrepo Install hourly service to build latest MC RPM and run createrepo ``` -I utilize `--service createrepo` to build the rpm repository used by Fedora/CentOS. #### containers @@ -103,13 +87,13 @@ I utilize `--service createrepo` to build the rpm repository used by Fedora/Cent Installs the latest version of JRiver Media Center from the repository. -* `installJRMC --service mediaserver` +* `installJRMC --install-repo --service mediaserver` Installs JRiver Media Center from the repository and starts/enables the mediaserver service. * `installJRMC --install-rpmbuild --restorefile /path/to/license.mjr --mcversion 26.0.56` - Builds JRiver Media Center version 26.0.56 RPM from the source DEB, installs it, and activates it using the specified .mjr license file (Fedora/CentOS only). + Builds JRiver Media Center version 26.0.56 RPM from the source DEB, installs it (RPM distros only), and activates it using the specified .mjr license file. * `installJRMC --createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user` @@ -119,11 +103,11 @@ I utilize `--service createrepo` to build the rpm repository used by Fedora/Cent Installs the jriver-createrepo timer and service to build the RPM, move it to the webroot, and run createrepo as `www-user`. -* `installJRMC --service x11vnc --service mediacenter --vncpass "letmein"` +* `installJRMC --install-repo --service x11vnc --service mediacenter --vncpass "letmein"` Installs services to share the existing local desktop via VNC and automatically run Media Center -* `installJRMC --service mediacenter-vncserver --vncpass "letmein"` +* `installJRMC --install-repo --service mediacenter-vncserver --vncpass "letmein"` Installs a service that starts a vncserver containing Media Center