koreader/koappimage

KOReader 虚拟开发环境 Docker 镜像

镜像概述和主要用途

该Docker镜像是KOReader的虚拟开发环境，旨在无需在本地系统配置依赖的情况下构建KOReader。它与官方每晚（nightly）构建KOReader所使用的镜像完全一致，可直接从Docker Hub拉取，简化开发和构建流程。

核心功能和特性

• 无需本地依赖配置：无需在本地系统安装KOReader构建所需的依赖，直接使用容器化环境
• 支持本地代码挂载：通过-v参数挂载本地KOReader代码目录，实现在容器中操作本地代码
• 兼容官方构建流程：与KOReader官方 nightly 构建使用相同镜像，确保构建一致性
• 支持运行模拟器：可通过本地X服务器或VNC在容器中运行KOReader模拟器，方便开发测试
• 跨平台支持：提供Windows系统下通过VNC运行模拟器的工作流

使用场景和适用范围

• KOReader开发人员进行本地开发、构建和测试
• 需要隔离开发环境，避免本地依赖冲突的场景
• 跨平台开发（Linux、Windows等系统下统一开发环境）
• 快速复现官方构建流程，验证构建问题

使用方法和配置说明

基础使用方法

1. 准备本地代码

首先克隆KOReader源代码：

bash
git clone https://github.com/koreader/koreader.git

2. 拉取并运行容器

从Docker Hub拉取镜像并运行容器，挂载本地代码目录：

bash
docker run -v $(pwd)/koreader:/home/ko/koreader -it koreader/koappimage:latest bash

3. 构建准备

进入容器后，切换到代码目录并获取第三方依赖：

bash
cd koreader && ./kodev fetch-thirdparty

运行KOReader模拟器

通过X服务器运行（Linux/macOS）

若本地有X服务器，可直接在容器中运行模拟器。需挂载X11套接字并设置DISPLAY环境变量：

bash
docker run -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix -v $(pwd)/koreader:/home/ko/koreader -it koreader/koappimage:latest bash -c "source ~/.bashrc && pushd koreader && ./kodev run"

注意：该命令会部分打破Docker容器隔离，假设KOReader为安全应用。

Windows系统VNC工作流

在Windows系统中，可通过VNC服务器在容器中运行KOReader模拟器，具体步骤如下：

1. 创建自定义Dockerfile

dockerfile
# 基于最新的koappimage镜像
FROM koreader/koappimage:latest
USER root
RUN apt-get update

# 安装VNC和虚拟显示服务
RUN apt-get install -y x11vnc xvfb

RUN mkdir ~/.vnc
# 设置VNC密码（此处为1234）
RUN x11vnc -storepasswd 1234 ~/.vnc/passwd
# 下载并提取KOReader AppImage
ADD https://github.com/koreader/koreader/releases/download/v2020.07.1/koreader-appimage-x86_64-linux-gnu-v2020.07.1.AppImage appimage
RUN chmod +x ./appimage
RUN ./appimage --appimage-extract
# 启动x11vnc服务器
CMD x11vnc -forever -usepw -create -shared

2. 构建自定义镜像

bash
docker build -f <自定义Dockerfile路径> -t vnckoappimage

3. 运行VNC容器

后台运行容器并映射VNC端口（5900）：

bash
docker run -p 5900:5900 --name vncko vnckoappimage:latest

4. 连接VNC服务器

使用VNC客户端连接 localhost:5900，密码为1234，进入包含xterm窗口的桌面环境。

5. 运行模拟器并编辑代码

在VNC的xterm窗口中，进入提取的AppImage目录并运行模拟器：

bash
cd /home/ko/squashfs-root/
./AppRun

在Windows主机上，通过winpty进入容器编辑代码：

bash
winpty docker exec -it vncko bash

编辑代码后，从KOReader模拟器的系统菜单中选择“重启KOReader”即可查看更改。

注意事项

• 若关闭模拟器后，xterm窗口可能失去键盘焦点
• Windows系统中，docker exec需前缀winpty以支持交互式会话
• 已在Windows 10 + Docker Desktop环境测试通过
• 可通过-v参数挂载本地提取的AppImage文件，实现本地编辑代码（待完善）
• 可使用docker cp命令导出编辑后的代码