retroarch-standalone-service/README.md

59 lines
2.5 KiB
Markdown
Raw Normal View History

2014-11-05 21:24:29 +01:00
# kodi-standalone-service
2019-04-29 16:38:00 +02:00
Systemd service units to run [Kodi](https://kodi.tv/) in standalone mode without the need for a DE. Both X11 and GBM are supported (makes little sense to use Wayland in standalone mode).
2014-11-05 21:24:29 +01:00
2017-03-09 20:52:05 +01:00
## Installation
### Arch Linux
2018-06-25 15:10:06 +02:00
Arch Linux users can find a PKGBUILD in the [AUR](https://aur.archlinux.org/packages/kodi-standalone-service) that will take care of everything. Simply install and use.
### Arch ARM
Users of Arch ARM should NOT use this method as the distro package provides analogous functionality.
2017-03-09 20:52:05 +01:00
### Other distros
2019-04-29 16:38:00 +02:00
Users of other distros should copy `kodi.service` and `kodi-gbm.service` to `/usr/lib/systemd/system/` and should create both a kodi user and home directory as follows:
2017-03-09 20:52:05 +01:00
```
2019-04-29 16:38:00 +02:00
useradd -c 'kodi user' -u 420 -g kodi -G audio,video,network,optical -d /var/lib/kodi -s /usr/bin/nologin kodi
2017-05-28 19:50:56 +02:00
passwd -l kodi > /dev/null
2017-03-09 20:52:05 +01:00
2018-08-24 20:04:04 +02:00
mkdir /var/lib/kodi
chown -R kodi:kodi /var/lib/kodi
2017-03-09 20:52:05 +01:00
```
2018-06-25 15:10:06 +02:00
Note that the kodi user's home directory is `/var/lib/kodi/` in this example, NOT `/home/kodi/` like a regular user.
2017-03-09 20:52:05 +01:00
## Usage
2019-04-29 16:38:00 +02:00
Simply call the requisite service to start, for kodi-x11:
2017-03-09 20:52:05 +01:00
```
systemctl start kodi
```
2019-04-29 16:38:00 +02:00
Or for kodi-gbm:
```
systemctl start kodi-gbm
```
2017-03-09 20:52:05 +01:00
2014-11-05 21:24:29 +01:00
## Dependency List
2019-04-29 16:38:00 +02:00
* kodi (x11 or gbm)
2015-05-27 22:53:54 +02:00
* polkit
2019-04-29 16:38:00 +02:00
* xorg-server and xorg-xinit (for running x11)
* libinput (for running gbm)
2014-11-05 21:24:29 +01:00
2018-06-25 15:10:06 +02:00
## Acknowledgments
Much of the credit for this service goes to the Arch Linux maintainers of the official kodi package. Note that they removed it upon the [1.16-1 release of Xorg](https://git.archlinux.org/svntogit/community.git/commit/trunk?h=packages/xbmc&id=9763c6d32678f3a3f45c195bfae92eee209d504f).
## Tips and Tricks
### Service not starting
2018-01-12 14:38:37 +01:00
Most users should not need `/etc/X11/Xwrapper.config` since the created X server becomes the [controlling process](http://www.freedesktop.org/software/systemd/man/systemd.exec.html#StandardInput=) of the VT to which it is bound. Most users does not mean all users. There have been reports of some AMD users still requiring this file. As well, users of Xorg's native modesetting driver may also require it.
2017-03-09 20:52:05 +01:00
The recommendation is to first try starting `kodi.service` without it, but if the service fails to start X, you may need to create `/etc/X11/Xwrapper.config` which should contain the following:
```
needs_root_rights = yes
```
2015-01-01 19:33:28 +01:00
2018-06-25 15:10:06 +02:00
### Running Kodi web service on a privileged port
Users wishing to run the kodi web service on a privileged port (i.e. <1024) can simply use a [systemd drop-in](https://wiki.archlinux.org/index.php/Systemd#Drop-in_files) modification as follows:
```
[Service]
AmbientCapabilities=CAP_NET_BIND_SERVICE
```