linuxserver/kanzi

DEPRECATION NOTICE
This image is deprecated. We will not offer support for this image and it will not be updated.
​linuxserver/kanzi​
​​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​​
​Kanzi, formerly titled Kodi-Alexa, this custom skill is the ultimate voice remote control for navigating Kodi. It can do anything you can think of (100+ intents). This container also contains lexigram-cli to setup Kanzi with an Amazon Developer Account and automatically deploy it to Amazon.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/kanzi:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Available
Tag
x86-64
✅
amd64-<version tag>
arm64
✅
arm64v8-<version tag>
armhf
✅
arm32v7-<version tag>
Application Setup
Initial setup
Once you start the container for the first time, you need to perform some steps before use.
1.Create an Amazon Developer Account here.​
2.Open a terminal in the /config directory of the docker container docker exec -itw /config kanzi bash
3.Enter lexigram login --no-browser true to setup your AWS credentials and copy the URL into a browser, login to your Amazon Developer Account and copy/paste the resulting authorisation code back into the terminal and press enter.
4.Edit the file kodi.config according to your local setup and this will be used by the included gunicorn server to respond to requests.
5.Restart the container to automatically deploy the Kanzi skill.
6.Reverse proxy this container with our LetsEncrypt container which contains preconfigured templates for reverse proxying the Kanzi container on either a subdomain or subfolder utilising Docker custom networking. Alternatively, if you already have an Nginx reverse proxy set up, you can use one of these location blocks to reverse proxy Kanzi to a subfolder or subdomain respectively.
Subfolder
location /kanzi {
  rewrite           ^/kanzi/(.*)  /$1  break;
  proxy_pass         https://$IP-ADDRESS:8000;
  proxy_redirect     https://$IP-ADDRESS:8000 /kanzi;
  proxy_set_header   Host $host;
  proxy_set_header   X-Real-IP $remote_addr;
  proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
  proxy_set_header   X-Forwarded-Server $host;
  proxy_set_header   X-Forwarded-Host $server_name;
}
Subdomain
  location / {
  proxy_pass         https://$IP-ADDRESS:8000;
  proxy_set_header   Host $host;
  proxy_set_header   X-Real-IP $remote_addr;
  proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
  proxy_set_header   X-Forwarded-Server $host;
  proxy_set_header   X-Forwarded-Host $server_name;
}
Strict reverse proxies
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
  kanzi:
    image: lscr.io/linuxserver/kanzi:latest
    container_name: kanzi
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - INVOCATION_NAME=kanzi
      - URL_ENDPOINT=https://server.com/kanzi/
    volumes:
      - </path/to/appdata/config>:/config
    ports:
      - 8000:8000
    restart: unless-stopped
docker cli (click here for more info)
docker run -d \
  --name=kanzi \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e INVOCATION_NAME=kanzi \
  -e URL_ENDPOINT=https://server.com/kanzi/ \
  -p 8000:8000 \
  -v </path/to/appdata/config>:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/kanzi:latest
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
Ports (-p)
Parameter
Function
8000
Application Port
Environment Variables (-e)
Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use EG Europe/London.
INVOCATION_NAME=kanzi
Specify an invocation name for this skill, use either kanzi or kod.
URL_ENDPOINT=https://server.com/kanzi/
Specify the URL at which the webserver is reachable either https://kanzi.server.com/ or https://server.com/kanzi/ Note the trailing slash MUST be included.
Volume Mappings (-v)
Volume
Function
/config
Configuration files.
Miscellaneous Options
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
​​
​ ​
​​
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
Shell access whilst the container is running:
docker exec -it kanzi /bin/bash
To monitor the logs of the container in realtime:
docker logs -f kanzi
Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kanzi
Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kanzi:latest
Versions
20.06.22: - Deprecate image.
13.04.19: - Initial Release.