Rename README for gogs precedence
This commit is contained in:
168
README.md
168
README.md
@@ -1,168 +0,0 @@
|
||||
# installJRMC
|
||||
|
||||
This program will install [JRiver Media Center](https://www.jriver.com/) and associated services on most Linux distributions.
|
||||
|
||||
You can find the latest version of installJRMC, changelog, and documentation in [my repository](https://git.bryanroessler.com/bryan/installJRMC).
|
||||
|
||||
## Executing
|
||||
|
||||
`installJRMC [--option [ARGUMENT]]`
|
||||
|
||||
`installJRMC` defaults to `--install=repo` on distros with MC repositories and `--install=local` on all others.
|
||||
Specifying `--build`, `--createrepo`, `--service`, or `--uninstall` disables the default install method.
|
||||
|
||||
### tl;dr
|
||||
|
||||
`curl https://git.bryanroessler.com/bryan/installJRMC/raw/master/installJRMC|bash`
|
||||
|
||||
## Options
|
||||
|
||||
```text
|
||||
$ 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 locally from official source package
|
||||
--build[=suse|fedora|centos|mandriva]
|
||||
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. "34.0.42" or "33" (default: latest)
|
||||
--mcrepo REPO
|
||||
Specify the MC repository, ex. "bullseye", "bookworm", "noble", etc (default: latest official)
|
||||
--arch ARCH
|
||||
Specify the MC architecture, ex. "amd64", "arm64", etc (default: host architecture)
|
||||
--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|mandriva]
|
||||
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
|
||||
--no-update
|
||||
Disable the installJRMC update check
|
||||
--yes, -y, --auto
|
||||
Always assume yes for questions
|
||||
--version, -v
|
||||
Print installJRMC 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)
|
||||
```
|
||||
|
||||
### `--service=`
|
||||
|
||||
```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=`
|
||||
|
||||
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`
|
||||
|
||||
#### `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
|
||||
|
||||
`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`.
|
||||
|
||||
**Note:** `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.
|
||||
|
||||
## 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
|
||||
* Disables BTRFS CoW for MC database directories
|
||||
* Activates MC if a valid license file is found in common locations
|
||||
|
||||
## Examples
|
||||
|
||||
* `installJRMC`
|
||||
|
||||
Install the latest version of MC from the best available repository.
|
||||
|
||||
* `installJRMC --mcversion 33 --debug`
|
||||
|
||||
Install the latest version of MC33 from the best available repository with debugging output.
|
||||
|
||||
* `installJRMC --install local --compat`
|
||||
|
||||
Install a more widely-compatible version of the latest MC (for older distros).
|
||||
|
||||
* `installJRMC --install repo --service jriver-mediacenter --service-type user`
|
||||
|
||||
Install MC from the repository and start/enable `jriver-mediacenter.service` as a user service.
|
||||
|
||||
* `installJRMC --install local --compat --restorefile /path/to/license.mjr --mcversion 34.0.42`
|
||||
|
||||
Build and install an MC 34.0.42 compatibility RPM locally and activate it using the `/path/to/license.mjr`
|
||||
|
||||
* `installJRMC --createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user`
|
||||
|
||||
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 --createrepo-user www-user`
|
||||
|
||||
Install the jriver-createrepo timer and service to build the RPM, move it to the webroot, and run createrepo as `www-user` hourly.
|
||||
|
||||
* `installJRMC --install repo --service jriver-x11vnc --service jriver-mediacenter --vncpass "letmein"`
|
||||
|
||||
Install services to share the existing local desktop via VNC and automatically run MC on startup.
|
||||
|
||||
* `installJRMC --install repo --service jriver-xvnc --display ":2"`
|
||||
|
||||
Install an Xvnc server on display ':2' that starts MC.
|
||||
|
||||
* `installJRMC --uninstall`
|
||||
|
||||
Uninstall MC, services, and firewall rules. This will **not** remove your media, media library/database, or library backup folder.
|
||||
|
||||
## Additional Info
|
||||
|
||||
Find a bug? [Let me know on Interact!](https://yabb.jriver.com/interact/index.php/topic,141168.0.html)
|
||||
|
||||
Find `installJRMC` useful? [Buy me a coffee with Paypal!](https://paypal.me/bryanroessler)
|
||||
|
||||
[↓ ↓ ↓ Bitcoin ↓ ↓ ↓](bitcoin:bc1q7wy0kszjavgcrvkxdg7mf3s6rh506rasnhfa4a)
|
||||
|
||||
[](bitcoin:bc1q7wy0kszjavgcrvkxdg7mf3s6rh506rasnhfa4a)
|
||||
Reference in New Issue
Block a user