README 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. # installJRMC
  2. This program will install [JRiver Media Center](https://www.jriver.com/) and associated services on most Linux distributions.
  3. You can find the latest version of installJRMC, changelog, and documentation in [my repository](https://git.bryanroessler.com/bryan/installJRMC).
  4. ## Executing
  5. `installJRMC [--option [ARGUMENT]]`
  6. `installJRMC` defaults to `--install=repo` on distros with MC repositories and `--install=local` on all others.
  7. Specifying `--build`, `--createrepo`, `--service`, or `--uninstall` disables the default install method.
  8. ### tl;dr
  9. `curl https://git.bryanroessler.com/bryan/installJRMC/raw/master/installJRMC|bash`
  10. ## Options
  11. ```text
  12. $ installJRMC --help
  13. --install, -i repo|local
  14. repo: Install MC from repository, future updates will be handled by the system package manager
  15. local: Build and install MC package locally from official source package
  16. --build[=suse|fedora|centos|mandriva]
  17. Build RPM from source DEB but do not install
  18. Optionally, specify a target distro for cross-building (ex. --build=suse, note the '=')
  19. --compat
  20. Build/install MC without minimum dependency version requirements
  21. --mcversion VERSION
  22. Build or install a specific MC version, ex. "34.0.42" or "33" (default: latest)
  23. --mcrepo REPO
  24. Specify the MC repository, ex. "bullseye", "bookworm", "noble", etc (default: latest official)
  25. --arch ARCH
  26. Specify the MC architecture, ex. "amd64", "arm64", etc (default: host architecture)
  27. --outputdir PATH
  28. Generate rpmbuild output in this PATH (default: ./output)
  29. --restorefile RESTOREFILE
  30. Restore file location for automatic license registration
  31. --betapass PASSWORD
  32. Enter beta team password for access to beta builds
  33. --service, -s SERVICE
  34. See SERVICES section below for the list of services to deploy
  35. --service-type user|system
  36. Starts services at boot (system) or user login (user) (default: per-service, see SERVICES)
  37. --container, -c CONTAINER (TODO: Under construction)
  38. See CONTAINERS section below for a list of containers to deploy
  39. --createrepo[=suse|fedora|centos|mandriva]
  40. Build rpm, copy to webroot, and run createrepo.
  41. Optionally, specify a target distro for non-native repo (ex. --createrepo=fedora, note the '=')
  42. --createrepo-webroot PATH
  43. The webroot directory to install the repo (default: /var/www/jriver/)
  44. --createrepo-user USER
  45. The web server user if different from the current user
  46. --no-update
  47. Disable the installJRMC update check
  48. --yes, -y, --auto
  49. Always assume yes for questions
  50. --version, -v
  51. Print installJRMC version and exit
  52. --debug, -d
  53. Print debug output
  54. --help, -h
  55. Print help dialog and exit
  56. --uninstall, -u
  57. Uninstall JRiver MC, service files, and firewall rules (does not remove library or media files)
  58. ```
  59. ### `--service=`
  60. ```text
  61. jriver-mediaserver [--service-type=user]
  62. Enable and start a mediaserver systemd service (requires an existing X server)
  63. jriver-mediacenter [--service-type=user]
  64. Enable and start a mediacenter systemd service (requires an existing X server)
  65. jriver-x11vnc [--service-type=user]
  66. Enable and start x11vnc for the local desktop (requires an existing X server, does NOT support Wayland)
  67. --vncpass and --display are also valid options (see below)
  68. jriver-xvnc [--service-type=system]
  69. Enable and start a new Xvnc session running JRiver Media Center
  70. --vncpass PASSWORD
  71. 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
  72. --display DISPLAY
  73. Manually specify display to use for x11vnc/Xvnc (ex. ':1')
  74. jriver-createrepo [--service-type=system]
  75. Install hourly service to build latest MC RPM and run createrepo
  76. ```
  77. #### `--service-type=`
  78. 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).
  79. 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`
  80. #### `jriver-x11vnc` versus `jriver-xvnc`
  81. [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.
  82. ### Containers
  83. **Coming soon!**
  84. ## Firewall
  85. `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`.
  86. **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.
  87. ## Other Nicities
  88. * Automatically updates `installJRMC` to the latest release
  89. * Activates external third-party repositories for improved media playback (hardware decoding, etc.)
  90. * Adds temporary legacy repositories to provide deprecated libraries
  91. * Links non-standard SSL certs
  92. * Disables BTRFS CoW for MC database directories
  93. * Activates MC if a valid license file is found in common locations
  94. ## Examples
  95. * `installJRMC`
  96. Install the latest version of MC from the best available repository.
  97. * `installJRMC --mcversion 33 --debug`
  98. Install the latest version of MC33 from the best available repository with debugging output.
  99. * `installJRMC --install local --compat`
  100. Install a more widely-compatible version of the latest MC (for older distros).
  101. * `installJRMC --install repo --service jriver-mediacenter --service-type user`
  102. Install MC from the repository and start/enable `jriver-mediacenter.service` as a user service.
  103. * `installJRMC --install local --compat --restorefile /path/to/license.mjr --mcversion 34.0.42`
  104. Build and install an MC 34.0.42 compatibility RPM locally and activate it using the `/path/to/license.mjr`
  105. * `installJRMC --createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user`
  106. Build an RPM locally for the current distro, move it to the webroot, and run createrepo as `www-user`.
  107. * `installJRMC --service jriver-createrepo --createrepo-webroot /srv/jriver/repo --createrepo-user www-user`
  108. Install the jriver-createrepo timer and service to build the RPM, move it to the webroot, and run createrepo as `www-user` hourly.
  109. * `installJRMC --install repo --service jriver-x11vnc --service jriver-mediacenter --vncpass "letmein"`
  110. Install services to share the existing local desktop via VNC and automatically run MC on startup.
  111. * `installJRMC --install repo --service jriver-xvnc --display ":2"`
  112. Install an Xvnc server on display ':2' that starts MC.
  113. * `installJRMC --uninstall`
  114. Uninstall MC, services, and firewall rules. This will **not** remove your media, media library/database, or library backup folder.
  115. ## Additional Info
  116. Find a bug? [Let me know on Interact!](https://yabb.jriver.com/interact/index.php/topic,141168.0.html)
  117. Find `installJRMC` useful? [Buy me a coffee with Paypal!](https://paypal.me/bryanroessler)
  118. [↓ ↓ ↓ Bitcoin ↓ ↓ ↓](bitcoin:bc1q7wy0kszjavgcrvkxdg7mf3s6rh506rasnhfa4a)
  119. [![Bitcoin](https://repos.bryanroessler.com/files/bc1q7wy0kszjavgcrvkxdg7mf3s6rh506rasnhfa4a.png)](bitcoin:bc1q7wy0kszjavgcrvkxdg7mf3s6rh506rasnhfa4a)