https://github.com/ehough/docker-kodi
Dockerized Kodi with audio and video
https://github.com/ehough/docker-kodi
audio docker htpc kodi media video
Last synced: about 1 year ago
JSON representation
Dockerized Kodi with audio and video
- Host: GitHub
- URL: https://github.com/ehough/docker-kodi
- Owner: ehough
- License: gpl-3.0
- Created: 2018-04-02T21:15:33.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T11:45:08.000Z (almost 2 years ago)
- Last Synced: 2025-03-30T21:07:37.443Z (about 1 year ago)
- Topics: audio, docker, htpc, kodi, media, video
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/erichough/kodi/
- Size: 74.2 KB
- Stars: 242
- Watchers: 13
- Forks: 61
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/code-of-conduct.md
Awesome Lists containing this project
README
# erichough/kodi
Dockerized [Kodi](https://kodi.tv/) with audio and video.
## Features
* fully-functional [Kodi](https://kodi.tv/) installation in a [Docker](https://www.docker.com/) container
* **audio** ([ALSA or PulseAudio](https://kodi.wiki/view/Linux_audio)) and **video** (with optional OpenGL hardware
video acceleration) via [x11docker](https://github.com/mviereck/x11docker/)
* simple, Ubuntu-based image that adheres to the [official Kodi installation instructions](https://kodi.wiki/view/HOW-TO:Install_Kodi_for_Linux#Installing_Kodi_on_Ubuntu-based_distributions)
* clean shutdown of Kodi when its container is terminated
## Host Prerequisites
The host system will need the following:
1. **Linux** and [**Docker**](https://www.docker.com)
This image should work on any Linux distribution with a functional Docker installation.
1. **A connected display and speaker(s)**
If you're looking for a headless Kodi installation, look elsewhere!
1. **[X](https://www.x.org/) or [Wayland](https://wayland.freedesktop.org/)**
Ensure that the packages for an X or Wayland server are present on the Docker host. Please consult your distribution's
documentation if you're not sure what to install. A display server does *not* need to be running ahead of time.
1. **[x11docker](https://github.com/mviereck/x11docker/)**
`x11docker` allows Docker-based applications to utilize X and/or Wayland on the host. Please follow the `x11docker`
[installation instructions](https://github.com/mviereck/x11docker#installation) and ensure that you have a
[working setup](https://github.com/mviereck/x11docker#examples) on the Docker host.
## Usage
### Starting Kodi
Use `x11docker` to start the `erichough/kodi` Docker image. Detailing the myriad of `x11docker` options is beyond the
scope of this document; please consult the [`x11docker` documentation](https://github.com/mviereck/x11docker/) to find
the set of options that work for your setup.
Below is an example command (split into multiple lines for clarity) that starts Kodi with a fresh X.Org X server with
PulseAudio sound, hardware video acceleration, a persistent Kodi home directory, and a shared read-only Docker mount for
media files:
$ x11docker --xorg \
--pulseaudio \
--gpu \
--homedir /host/path/to/kodi/home \
-- -v /host/path/to/media:/media:ro -- \
erichough/kodi
Note that the optional argument passed between a pair of `--` defines additional arguments to be passed to `docker run`.
### Stopping Kodi
You can shut down Kodi just as you normally would; i.e. by using the power menu from the Kodi home screen.
Behind the scenes, the Docker container and `x11docker` processes will terminate cleanly.
You can also [terminate the container from the command line](doc/advanced.md#command-line-shutdown).
### Example systemd Service Unit
[Unit]
Description=Dockerized Kodi
Requires=docker.service
After=network.target docker.service
[Service]
ExecStartPre=/usr/bin/docker pull erichough/kodi
ExecStart=/usr/bin/x11docker ... erichough/kodi
Restart=always
KillMode=process
[Install]
WantedBy=multi-user.target
## Advanced
The [advanced topics](doc/advanced.md) documentation describes a few more useful features and functionality:
* [Custom add-ons](doc/advanced.md#custom-add-ons)
* [Image Variants](doc/advanced.md#image-variants)
* [Custom Startup Behavior](doc/advanced.md#custom-startup-behavior)
* [Command-Line Shutdown](doc/advanced.md#command-line-shutdown)
## Help!
Something not working quite right? Are you stuck? Please ask your questions in the
[discussion group](https://github.com/ehough/docker-kodi/discussions), where we exchange help and share ideas.
## Contributing
Constructive criticism and contributions are welcome! Please
[submit an issue](https://github.com/ehough/docker-kodi/issues/new) or
[pull request](https://github.com/ehough/docker-kodi/compare).