retroarch-standalone-service/README.md

kodi-standalone-service

Systemd service units to run Kodi in standalone mode without the need for a DE. X11, Wayland, and GBM are supported.

Which one to choose?

In terms of functionality, X11 is probably the most mature and feature rich. Wayland is next in line and should be considered on-par with X11, however, a known limitation of Wayland is having the resolution and frame rate set in the compositor rather than in kodi's GUI. As well, Wayland currently does not support VT switching. GBM has some known features it lacks compared the X11 and Wayland. A complete list can be found in Kodi issue 14876.

Another factor that may affect choice is the number of dependencies required to run which will vary distro-to-distro.

Installation

Arch Linux

Arch Linux users can find a PKGBUILD in the AUR that will take care of everything. Simply install and use.

ARM distros

Users of ARM distros such as Arch ARM, Raspberry Pi OS (formerly Raspbian), etc. should NOT use these files since their official corresponding kodi packages supply their own version of a service. If you are knowledgeable enough with your distro, feel free to use/modify.

Ubuntu

For the kodi user to access devices on /dev/ttyxxxx, users will need to edit init/sysusers.conf and uncomment the line corresponding to enable membership in the dialout group.

Other distros (manual installation)

Users of other distros can just run make install as the root user. Then, as the root user:

<<<<<<< HEAD

• Run systemd-sysusers
• Run systemd-tmpfiles --create
• Run udevadm control --reload-rules && udevadm trigger =======
• init/*.service to /usr/lib/systemd/system/
• init/sysusers.conf to /usr/lib/sysusers.d/, then run systemd-sysusers
• init/tmpfiles.conf to /usr/lib/tmpfiles.d/, then run systemd-tmpfiles --create

parent of 34515c3 (Consistent behavior on a systemctl stop vs reboot)

Note that the kodi user's home directory is /var/lib/kodi/ in this example, NOT /home/kodi/ like a regular user.

Usage

Simply start/enable the requisite service.

Dependencies

• kodi (x11 or wayland or gbm)
• libinput and cage (for running wayland)
• libinput (for running gbm)
• polkit
• xorg-server and xorg-xinit (for running x11)

Passing environment variables to the service

Should the need arise, one can pass environment variables to the service by creating /etc/conf.d/kodi-standalone and populating it with the needed variables.

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.

Tips and Tricks

Pulseaudio

Currently, users of pulseaudio will need configure it to run in system mode to work with these service files.

Service not starting

Most users should not need /etc/X11/Xwrapper.config since the created X server becomes the controlling process 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.

The recommendation is to first try starting kodi-x11.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

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 modification as follows:

[Service]
AmbientCapabilities=CAP_NET_BIND_SERVICE