Skip to content

About

OlivOS 的 Docker 部署包,直接消费上游编译好的 release 产物

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

19 Commits

Folders and files

Repository files navigation

OlivaDiceDocker

在 Linux 上用 Docker 部署 OlivOS + NapCat,附带青果骰的常用核心插件。

镜像不依赖上游源码。构建时直接下载上游 release 里编译好的产物——主程序用 PyInstaller 打好的单文件二进制,插件用各自 release 里的 opk。所以构建很快,镜像里也不需要 Python 环境。

镜像地址:olivosteam/olivadice

镜像标签

  • latest / stable / <版本号> —— 正式发布通道,对应上游最新的正式版
  • pre / <版本号> —— 预发布通道,对应上游最新的预发布版

latest 始终指向正式版,预发布通道不会去动它。

用 docker-compose 部署

推荐用这种方式。仓库里的 docker-compose.yml 是一份 NapCat 的组装示例,可以直接拿来用。

组装出来是两个容器:olivos-app 跑 OlivOS 本体,napcat 负责 QQ 登录,两者在同一张 bridge 网络上按服务名互相访问。

对外开的端口:

  • 20480 —— OlivOS 自带的 WebUI
  • 6099 —— NapCat 的 WebUI,扫码登录用的

两个容器没有启动顺序要求,olivos-app 连不上 NapCat 时会自己重试。

准备

先装好 Docker 和 Docker Compose,然后建目录、把 compose 和 .env 放进去:

mkdir -p -m 755 /opt/OlivaDiceDocker
cd /opt/OlivaDiceDocker

wget https://raw.githubusercontent.com/OlivOS-Team/OlivaDiceDocker/refs/heads/main/docker-compose.yml
echo 'ACCOUNT=你的骰娘QQ号' > .env

.env 里的 ACCOUNT 是骰娘账号,必须改掉。

启动

docker compose up -d      # 启动
docker compose ps         # 查看状态
docker compose logs -f    # 跟踪日志
docker compose down       # 停止

更新到新版本:

docker compose pull
docker compose up -d

程序文件在容器启动时会自动比对更新,配置和数据都留着,不会被覆盖。

登录

容器日志里能看到二维码,也可以直接访问 NapCat 的 WebUI 扫码登录,端口 6099。

用 docker run 部署

不想用 compose 的话,等价的手工方式是这样。两个容器要在同一张网络上,否则 OlivOS 找不到 NapCat。

ACCOUNT=你的骰娘QQ号

docker network create olivos

# 登录端
# 后面两个 OlivOS 数据目录也要挂进来,NapCat 发图发文件要按同样的路径读。
docker run -d \
  --name napcat \
  --network olivos \
  --hostname olivos-${ACCOUNT} \
  -p 6099:6099 \
  -e ACCOUNT=${ACCOUNT} \
  -e MODE=olivos \
  -v "$PWD/napcat/config:/app/napcat/config" \
  -v "$PWD/napcat/QQ_DATA:/app/.config/QQ" \
  -v "$PWD/data/resources:/app/OlivOS/data" \
  -v "$PWD/data/plugin:/app/OlivOS/plugin" \
  mlikiowa/napcat-docker:latest

# OlivOS 本体
# 名字要用 olivos-app:自动生成的 OneBot 配置里指向的是
# http://olivos-app:55001/OlivOSMsgApi/...,NapCat 得靠这个名字找到它。
docker run -d \
  --name olivos-app \
  --network olivos \
  -p 20480:20480 \
  -e LOGIN_UIN=${ACCOUNT} \
  -e MODE=napcat \
  -v "$PWD/data/conf:/app/OlivOS/conf" \
  -v "$PWD/data/plugin:/app/OlivOS/plugin" \
  -v "$PWD/data/logfile:/app/OlivOS/logfile" \
  -v "$PWD/data/resources:/app/OlivOS/data" \
  -v "$PWD/napcat/config:/app/napcat/config" \
  olivosteam/olivadice:latest

两个容器没有启动顺序要求,谁先起来都行——OlivOS 连不上 NapCat 时会自己重试。

镜像也支持把登录端换成 LLBot:环境变量传 MODE=llbot,初始化脚本会把账号的 SDK 地址指向 http://llbot、登录端配置写成 LLBot 的格式。但仓库里没有提供 LLBot 的 compose 示例,得自己按上面同样的思路组装一个名为 llbot 的容器。

管理面板

这里有两个不同的 WebUI,别混了。

OlivOS 自带的 WebUI —— 默认监听 20480,compose 里映射的就是这个。登录要输令牌,令牌在 data/conf/webui_token.txt,第一次启动时自动生成。

容器启动时初始化脚本会自动把 models.OlivOS_webUI.server.host 写成 0.0.0.0。上游默认绑 127.0.0.1,容器里那样映射出去也没人连得上,所以替你改了。只动 host 这一个字段,你自己设过的端口、令牌路径都保留。

OlivaDiceWebUI 插件 —— 镜像里带了它的两个版本,跟上面那个是两回事:

  • 官方接入版(OlivaDiceWebUI.opk):做成 OlivOS 自带 WebUI 里的一个页面,自己不占端口。前提是上面那个 WebUI 能访问。
  • 独立服务版(OlivaDiceWebUIStandalone.opk):自己监听 HTTP 端口,默认 8765,不依赖 OlivOS 的 WebUI。compose 里默认没映射,需要的话把那行 8765:8765 的注释打开。

独立版的监听地址和端口由插件自己维护,在面板里改就行。不要去设 OLIVADICE_STANDALONE_WEBUI_PORT 之类的环境变量——环境变量优先级高于面板里的设置,一设就再也改不动了。

数据目录

挂出来的只有需要持久化的目录,程序本体留在容器里。这样升级就是换个镜像,用户也碰不到程序文件,不会因为误删、误改或者权限问题把程序弄坏。

compose 文件同级:

  • data/conf/ —— OlivOS 自身配置:account.json、config.json、WebUI 令牌,第一次启动自动生成
  • data/plugin/ —— 插件相关的几块:
    • app/ —— 插件 opk,镜像里带的那些会在启动时更新
    • conf/ —— 插件自己的设置
    • data/ —— 骰子数据、人物卡、存档,升级不会动
    • backup/ —— 插件自己做的备份
  • data/logfile/ —— 运行日志
  • data/resources/ —— 容器里 /app/OlivOS/data 的落地处,放 images/ 这些资源。发图发文件要靠它,见下面
  • napcat/ —— 登录端配置与 QQ 数据,属于 NapCat 自己管的目录

你自己放进 data/plugin/app/ 的第三方插件不会被碰,只有镜像里固定的那几个会被更新。

data/resources/ 和 data/plugin/ 这两个目录同时也挂给了 NapCat 容器,而且是挂在同样的绝对路径下。原因是 NapCat 发图不是把文件内容塞进报文——OlivOS 会把相对路径的图片重定向到 /app/OlivOS/data/images/,然后用 file:///<绝对路径> 交给 NapCat,NapCat 得在自己文件系统里读到那个路径。两个容器看到的路径不一致,图就发不出去。

data/resources/webui/ 是 WebUI 前端,每次启动从镜像里释放出来;data/plugin/tmp/ 是插件临时文件。这两处也在挂载目录里,但删了都能自己长回来。

从旧版挂载方式迁移

以前的 compose 是把整个 ./OlivOS 目录挂进容器的,数据都在那下面。新版只挂数据子目录,所以要把数据搬到新位置,否则容器会当成全新安装:

mkdir -p data
mv OlivOS/conf     data/conf
mv OlivOS/plugin   data/plugin
mv OlivOS/logfile  data/logfile  2>/dev/null || true
mv OlivOS/data     data/resources 2>/dev/null || true

搬完把旧的 OlivOS/ 目录删掉就行。里面的源码和构建产物新方案根本不用,conf/ 和 plugin/ 已经搬走了。

如果之前用的是更早那种在容器内拉源码的老方案,那个 OlivOS/ 目录里还躺着一整套源码——同样不要了,删掉即可。入口脚本会检查这种情况:万一还有人把整个目录挂进来,/app/OlivOS/OlivOS 是个目录而不是可执行文件,容器会直接报错并提示按上面的步骤迁移,不会默默删掉你的文件。

配置是怎么生成的

容器每次启动都会跑一遍初始化脚本,原则是只补缺,不覆盖:

  • conf/config.json —— 确保 WebUI 监听地址是 0.0.0.0。只改这一个字段,端口、令牌路径、以及其它模型的配置都保持你设的值。
  • conf/account.json —— 确保当前 MODE 对应的账号在。已有账号一律保留:你另外配的 kook、别的 QQ、别的接入方式都不会被删掉;同 id 的条目也只在缺字段时补齐,不会整个替换。
  • conf/account.json 里的 server.type —— 值是 port 的会被改成 post。OlivOS 1.0.0 起只认 post / auto / websocket / websocket_host,写 port 的账号会被整笔跳过,症状是收不到任何消息。改之前原文件会备份成 account.json.bak-port-type。
  • NapCat / LLBot 的登录端配置 —— 文件不存在才生成,已存在的一律不动。

配置如果是坏的 JSON(比如手工改崩了),会先备份成 *.broken-<时间戳> 再重建,不会直接丢掉。整个脚本是幂等的,重复启动不会有额外改动。

更新机制

镜像只在两种情况下发新版:

  1. 上游 OlivOS 主程序发了新版本
  2. OlivaDiceCore 发了新版本

其余插件(Joy / Logger / Master / Odyssey / StoryCore / ChanceCustom / WebUI)的新版本不会单独触发构建,但每次构建时都会连同当时的最新版本一起打包进去。这么定是因为 WebUI 一天能发两三次,全都要触发构建的话镜像仓库会被刷屏。

版本信息全部记在 release_info.json 里,由 scripts/resolve-release.sh 解析上游生成。同一个清单构建出来的镜像,每个组件的版本都是固定的,不会出现同一个 tag 拉两次内容不一样的情况。

架构说明

linux/amd64 和 linux/arm64 都发。docker pull 会按宿主机的架构自动选,不需要指定。

上游从 1.0.0 起两个架构都有产物,镜像跟着清单走——release_info.json 里 arm64 有地址就发双架构,没有就只发 amd64,不用改配置。

维护说明

镜像发布全走 Actions,用到的两个工作流:

  • sync-release.yml 每 6 小时跑一次,解析上游版本写进 release_info.json。只有 OlivOS 主程序或 OlivaDiceCore 出了新版才会提交清单并触发构建,其余插件的新版本只是在构建时一并带上。
  • docker-publish.yml 读清单构建镜像并推送。也可以手动跑,指定通道即可。

需要配的东西:

Actions 权限 —— sync-release.yml 使用仓库自动提供的 GITHUB_TOKEN 更新版本清单并派发镜像构建,不需要额外配置 PAT。工作流声明了 contents: write 和 actions: write;如果仓库或组织策略收紧了 Actions token 权限,需要允许这两项权限。派发 API 返回错误时,同步工作流会失败并显示错误,不会再把未启动的构建伪报为成功。

GHCR 包可见性(首次必须手动改一次) —— GHCR 的包首次推送后默认是私有的,这时候用户 docker pull 会拿到 403。推完第一个镜像后去 package 的 Settings 里把 visibility 改成 public。

推 Docker Hub(可选) —— 需要一个官方 Docker Hub 账号。在仓库的 Variables 里加一个 DOCKERHUB_REPO(值形如 账号名/仓库名),再在 Secrets 里配 DOCKERHUB_USERNAME 和 DOCKERHUB_TOKEN。三个都齐了就会在推 GHCR 的同时也推一份;任何一个没配就只推 GHCR,工作流会自动跳过,不会报错。

发新版本不需要手动打 tag,sync-release 检测到上游更新会自动跑完整条链路。

许可

AGPL-3.0

About

OlivOS 的 Docker 部署包,直接消费上游编译好的 release 产物

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages