Update README
This commit is contained in:
88
README.md
88
README.md
@@ -4,21 +4,21 @@ Installs [JRiver Media Center](https://www.jriver.com/) and associated services
|
||||
|
||||
You can find the latest version of installJRMC, changelog, and documentation in [my repository](https://git.bryanroessler.com/bryan/installJRMC).
|
||||
|
||||
## Usage
|
||||
|
||||
`installJRMC [--option [ARGUMENT]]`
|
||||
|
||||
`installJRMC` defaults to `--install=repo` on distros with Media Center repositories and `--install=local` on others.
|
||||
Specifying `--build`, `--createrepo`, `--service`, or `--uninstall` disables the default install method.
|
||||
|
||||
### tl;dr
|
||||
## tl;dr
|
||||
|
||||
`curl https://git.bryanroessler.com/bryan/installJRMC/raw/branch/master/installJRMC|bash`
|
||||
|
||||
## Options
|
||||
## Usage
|
||||
|
||||
```text
|
||||
$ installJRMC --help
|
||||
USAGE:
|
||||
installJRMC [[OPTION] [VALUE]]...
|
||||
|
||||
installJRMC defaults to --install=repo on platforms with a JRiver repository and --install=local on others.
|
||||
Specifying --build, --createrepo, --service, or --uninstall disables the default install method.
|
||||
|
||||
OPTIONS
|
||||
--install, -i repo|local
|
||||
repo: Install MC from repository, updates are handled by the system package manager.
|
||||
local: Build and install MC locally from official source package.
|
||||
@@ -29,10 +29,10 @@ $ installJRMC --help
|
||||
Build/install MC locally without minimum dependency version requirements.
|
||||
--mcversion VERSION
|
||||
Specify the MC version, ex. "35.0.68" or "35" (default: latest release).
|
||||
--arch VERSION
|
||||
Specify the target MC architecture, ex. "amd64", "arm64", etc (default: host).
|
||||
--mcrepo REPO
|
||||
Specify the MC repository, ex. "bullseye", "bookworm", "noble", etc (default: auto).
|
||||
--arch ARCH
|
||||
Specify the target MC architecture, ex. "amd64", "arm64", etc (default: host).
|
||||
--outputdir PATH
|
||||
Generate reusable installJRMC output in this PATH (default: ./output).
|
||||
--restorefile MJR_FILE
|
||||
@@ -56,6 +56,26 @@ $ installJRMC --help
|
||||
--help, -h
|
||||
Print help dialog and exit.
|
||||
|
||||
SERVICES
|
||||
jriver-mediaserver (default --service-type=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).
|
||||
Usually combined with jriver-mediaserver or jriver-mediacenter services.
|
||||
--vncpass and --display are optional (see below).
|
||||
jriver-xvnc (system)
|
||||
Enable and start a new Xvnc session running JRiver Media Center.
|
||||
--vncpass PASSWORD
|
||||
Set the vnc password for x11vnc/Xvnc access. If no password is set, installJRMC
|
||||
will either use existing password stored in $HOME/.vnc/jrmc_passwd or else no password.
|
||||
--display DISPLAY
|
||||
Display to use for x11vnc/Xvnc (default: The current display (x11vnc) or the
|
||||
current display incremented by 1 (Xvnc)).
|
||||
jriver-createrepo (system)
|
||||
Install hourly service to build latest MC RPM and run createrepo.
|
||||
|
||||
ADVANCED OPTIONS
|
||||
--container, -c CONTAINER (TODO: Under construction)
|
||||
See CONTAINERS section below for a list of possible services to install.
|
||||
@@ -77,51 +97,33 @@ ADVANCED OPTIONS
|
||||
GPG key ID, fingerprint, or UID used for --sign.
|
||||
```
|
||||
|
||||
### `--service=`
|
||||
## Notes
|
||||
|
||||
```text
|
||||
jriver-mediaserver [--service-type=user]
|
||||
Enable and start a mediaserver systemd service (requires an existing X server).
|
||||
jriver-mediacenter [--service-type=user]
|
||||
Enable and start a mediacenter systemd service (requires an existing X server).
|
||||
jriver-x11vnc [--service-type=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 [--service-type=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 [--service-type=system]
|
||||
Install hourly service to build latest MC RPM and run createrepo.
|
||||
```
|
||||
|
||||
#### `--service-type=`
|
||||
### --service-type=
|
||||
|
||||
Services use a sane default `--service-type` listed next to the service name in the [`--service=`](#--service) section. User services begin at user login and are managed by the unprivileged user, for example: `systemctl --user stop jriver-mediacenter`. System services begin at boot and are managed by root, for example: `sudo systemctl stop jriver-servicename@username.service`. It is possible to run all services of a particular user at boot using [`sudo loginctl enable-linger username`](https://www.freedesktop.org/software/systemd/man/loginctl.html).
|
||||
|
||||
Multiple services (but not `--service-types`) can be installed at one time using multiple `--service` blocks: `installJRMC --install=repo --service=jriver-x11vnc --service=jriver-mediacenter`
|
||||
Multiple services (but not `--service-types`) can be installed using multiple `--service` blocks: `installJRMC --install=repo --service=jriver-x11vnc --service=jriver-mediacenter`
|
||||
|
||||
#### `jriver-x11vnc` versus `jriver-xvnc`
|
||||
### jriver-x11vnc versus jriver-xvnc
|
||||
|
||||
[jriver-x11vnc](http://www.karlrunge.com/x11vnc/) shares the existing X display via VNC and can be combined with additional services to start Media Center or Media Server. Conversely, [jriver-xvnc](https://tigervnc.org/doc/Xvnc.html) creates a new Xvnc display and starts a JRiver Media Center service in the foreground of the new VNC display.
|
||||
|
||||
### Containers
|
||||
|
||||
**Coming soon!**
|
||||
|
||||
## Firewall
|
||||
### Firewall
|
||||
|
||||
`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` (if available).
|
||||
|
||||
## Other Nicities
|
||||
### Other Nicities
|
||||
|
||||
* Automatically updates `installJRMC` to the latest release.
|
||||
* Activates external third-party repositories for improved media playback (hardware decoding, etc.).
|
||||
* Adds temporary legacy repositories to provide deprecated libraries.
|
||||
* Links non-standard SSL certs.
|
||||
* Activates MC if a valid license file is found in common locations.
|
||||
* Symlinks non-standard SSL certs.
|
||||
* Activates MC if a valid license file is found in common locations like Downloads or Documents directories.
|
||||
|
||||
### Containers
|
||||
|
||||
**Coming soon!**
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -149,9 +151,9 @@ Multiple services (but not `--service-types`) can be installed at one time using
|
||||
|
||||
Build an RPM locally for the current distro, move it to the webroot, and run createrepo as `www-user`.
|
||||
|
||||
* `installJRMC --service jriver-createrepo --createrepo-webroot /srv/jriver/repo --webroot-user www-user`
|
||||
* `installJRMC --service=jriver-createrepo --webroot-user=nginx --createrepo-webroot "/var/www/repos.bryanroessler.com/jriver" --createrepo=fedora --sign --sign-key 7C008BD7B33C185837C81D033C9D3657EE0BC6D9`
|
||||
|
||||
Install the jriver-createrepo timer and service to build the RPM, move it to the webroot, and run createrepo as `www-user` hourly.
|
||||
Install the jriver-createrepo timer and service to build/sign the RPM, move it to the webroot, and run createrepo as user `nginx` hourly.
|
||||
|
||||
* `installJRMC --createrepo --webroot-user nginx --sign --sign-user bryan --sign-key 0xDEADBEEF`
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
# shellcheck disable=SC2329
|
||||
shopt -s extglob
|
||||
|
||||
declare -g SCRIPT_VERSION="1.35.14"
|
||||
declare -g SCRIPT_VERSION="1.35.15-dev"
|
||||
declare -g MC_VERSION_HARDCODE="35.0.68" # do find all replace
|
||||
declare -g MC_REPO_HARDCODE="bookworm" # should match the MC_VERSION_HARDCODE
|
||||
declare -g BOARD_ID="92.0" # MC35 board ID for fallback latest version detection
|
||||
|
||||
Reference in New Issue
Block a user