linuxserver/kanzi
[!TIP]
前半部分是翻译官方的文档,最后一部分是我的简单试用(个别软件会深度试用),如果对Docker已经有一定的了解了,可以直接跳转到最后面 翻译之外 这部分来查看。
Kanzi → https://lexigr.am/
GitHub → https://github.com/linuxserver/docker-kanzi
Docker Hub → https://hub.docker.com/r/linuxserver/kanzi
Kanzi 以前的名称是 Kodi-Alexa 。它可以通过语音来遥控 Kodi 。
它可以做任何您能想到的事情(超过100个意图)。此容器还包含 lexigram-cli,用于使用 Amazon Developer Account 设置 Kanzi 并将其自动部署到 Amazon。
支持的系统架构
得益于docker的跨平台属性,我们的镜像也支持多架构(如,x86-64、arm64、armhf)。
直接拉取 ghcr.io/linuxserver/kanzi
应该就可以自动获取适合你系统架构的版本,当然你也可以通过 tag 获取特定的版本。
架构 | Tag |
---|---|
x86-64 | amd64-latest |
arm64 | arm64v8-latest |
armhf | arm32v7-latest |
拉取镜像
docker pull ghcr.io/linuxserver/kanzi
使用方法
以下是一些简单的示例。
docker-compose
兼容docker-compose v2
---
version: "2.1"
services:
kanzi:
image: ghcr.io/linuxserver/kanzi
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
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 \
ghcr.io/linuxserver/kanzi
参数
Docker镜像在使用的时候需要配置一些参数,这些参数使用 :
分隔,分别表示 宿主机:容器内
。例如 -p 8080:80
指的是将容器内的80
端口映射到宿主机上的8080
端口,即通过宿主机网络访问的话,访问8080
端口即是访问容器内的80
端口。
端口(-p
)
port | 说明 |
---|---|
8000 |
访问端口 |
环境变量(-e
)
env | 说明 |
---|---|
PUID=1000 |
用户的 UID,详见下面的说明 |
PGID=1000 |
用户的 GID,详见下面的说明 |
TZ=Europe/London |
设置时区,在国内的话可以使用 Asia/Shanghai |
INVOCATION_NAME=kanzi |
指定此技能的调用名称,使用kanzi或kod。 |
URL_ENDPOINT=https://server.com/kanzi/ |
指定https://kanzi.server.com/ 或https://server.com/kanzi/ 上可访问Web服务器的URL。(必须包括斜杠) |
卷映射(-v
)
volume | 说明 |
---|---|
/config |
配置文件所在路径 |
从文件加载环境变量
可以使用前缀名为 FILE__
的文件来加载环境变量。
例:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
将把 /run/secrets/mysecretpassword
文件中的内容作为 PASSWORD
变量的值。
运行程序的umask(文件掩码)
我们所有的镜像都可以使用 -e UMASK=022 来设置覆盖容器内服务的umask。关于Linux umask可以通过这里了解,或自行百度学习。
UID和GID
当使用 -v
映射卷的时候,宿主机和容器内会出现关于权限的问题,我们的镜像可以通过指定 PUID
和 GUID
来避免此类问题。
可以使用你目前正在使用的用户的UID和GID进行设置,这样就不会存在权限问题。
可以通过如下的方式查看当前用户的UID和GID:
$ id $user
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
[!NOTE]
如果没特殊需求,可以将后续所有容器的id都设置为当前非root用户的id,这样会省去解决很多关于文件权限的问题(可以查看 什么是PUID和PGID 这篇文章了解更多)。当然,如果有特殊需要可以给不同的容器设置不同的id,即分配给不同的用户。使用
useradd
命令即可添加用户。通常来说,除root账户外,第一个建立的用户的UID和GID都是1000,然后递增生成。
安装说明
首次启动容器后,需要在使用之前执行一些步骤。
- 创建一个Amazon Developer Account。(https://developer.amazon.com/)
- 在Docker容器的
/config
目录中打开一个终端docker exec -itw / config kanzi bash
- 输入
lexigram login --no-browser true
来设置您的AWS凭证并将URL复制到浏览器中,登录到您的Amazon Developer Account,然后将生成的授权代码复制/粘贴回终端,然后按回车确认。 - 根据您的本地设置编辑文件 kodi.config ,随附的 gunicorn 服务器将使用该文件来响应请求。
- 重新启动容器以自动部署 Kanzi 。
- 使用我们的 swag 容器反向代理此容器,该容器包含预配置的模板,这些模板可利用Docker自定义网络在子域或子文件夹上反向代理 Kanzi 容器。另外,如果您已经设置了Nginx反向代理,则可以使用以下位置块之一将Kanzi代理分别反向到子文件夹或子域。
子文件夹
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;
}
子域名
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;
}
支持
- 进入容器:
docker exec -it kanzi /bin/bash
- 查看容器日志:
docker logs -f kanzi
- 查看容器版本号:
docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' kanzi
- 查看镜像版本号:
docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/kanzi
翻译之外
暂未试用