teic/jenkins

Jenkins

本仓库包含用于设置和维护 TEI Jenkins 构建服务器的 Dockerfile、作业配置和说明。现成的 Docker 镜像可在 https://hub.docker.com/r/teic/jenkins/ 获取，若已安装 Docker，可通过以下命令拉取：

docker pull docker.xuanyuan.run/teic/jenkins

然后可通过以下命令运行：

docker run --rm --name teijenkins -p 8080:8080 -p 50000:50000 -v /your/jenkins_home:/var/jenkins_home docker.xuanyuan.run/teic/jenkins

数据将存储在 /your/jenkins_home（映射到容器内的 /var/jenkins_home）。

注意：Jenkins 服务器上 TEI 构建的完整运行可能占用超过 10GB 磁盘空间。

详细说明

首次运行此镜像时，建议为 jenkins_home 使用空卷。这将触发快速设置向导，您需添加用户并可选择安装额外插件（可通过取消选择所有插件跳过插件安装步骤——本镜像已包含所有必要插件）。

访问（仍为初始状态的）Jenkins 后，应进入 Jenkins 管理面板（“系统配置”）并执行以下操作：

1. 添加控制台输出解析：将本仓库中的 tei-log-parse-rules 文件复制到您的 jenkins_home。然后将“解析规则文件”设置为 /var/jenkins_home/tei-log-parse-rules，并输入适当描述（例如“TEI 日志解析规则”）。
2. 设置/检查正确的 Jenkins URL。

最后，需填充 jenkins_home 内的 jobs 目录并添加 tei-log-parse-rules 文件；这些文件可从 jenkins_home 中的 tar 归档文件获取，只需在该目录中执行 tar xfz jobs.tar.gz 即可完成部署。点击“从磁盘重新加载配置”使更改生效。

设置完成后，请记得备份/保留数据目录 /your/jenkins_home，以便启动新容器时可继承作业数据和配置。

内容安全策略 (CSP)

Jenkins 1.641 / Jenkins 1.625.3 为 Jenkins 提供的静态文件引入了 https://wiki.jenkins.io/display/JENKINS/Configuring+Content+Security+Policy 头。因此，从 Jenkins 查看 TEI 指南时可能会显示某些工件（如参考文献工具提示）异常。可通过向 Jenkins 启动脚本传递适当的 Java 选项来放宽 CSP，例如：

docker run --env JAVA_OPTS="-Dhudson.model.DirectoryBrowserSupport.CSP='default-src self; img-src *'" …

不使用 Jenkins 服务器的 Docker 镜像用法

当需要在本地机器上测试或构建指南（和/或样式表）时，此 Docker 镜像同样适用。需将本地样式表和 TEI 目录挂载到容器，并设置工作目录。

与样式表一起使用

导航至从 GitHub 克隆的样式表仓库，输入：

docker run --rm -v `pwd`:/stylesheet -w /stylesheet -it --entrypoint "make" docker.xuanyuan.run/teic/jenkins:dev test

此命令会将当前目录挂载到容器，并将容器内的工作目录设置为该目录。直接将 make 命令设为入口点，因此镜像名称后的所有内容将作为参数附加到 make 命令。上述示例中使用 "test" 测试当前状态；另一个有用的目标是 "dist"，用于创建可分发文件。

与指南一起使用

导航至从 GitHub 克隆的指南仓库，输入：

docker run --rm -v `pwd`:/tei -w /tei/P5 -v /YOUR/PATH/TO/TEI-STYLESHEETS:/usr/share/xml/tei/stylesheet -it --entrypoint "make" docker.xuanyuan.run/teic/jenkins:dev test

此命令会将当前目录挂载到容器，并将容器内的工作目录设置为子目录 "P5"。直接将 make 命令设为入口点，因此镜像名称后的所有内容将作为参数附加到 make 命令。上述示例中使用 "test" 测试当前状态；另一个有用的目标是 "dist"，用于创建可分发文件。

限制

本镜像未安装用于创建指南 .mobi 版本的 kindlegen（非免费软件），也未安装构建样式表文档所需的 Oxygen 最小安装版（需要许可证）。若在 Docker 容器中安装这些组件，相关构建过程将自动生效。

添加 oXygen

• 从 Syncrosoft 下载 oXygenXML 编辑器，提取/安装到某个目录。
• 将该目录（含许可证文件）挂载到容器的 /usr/share/oxygen。

添加 kindlegen

• 从 https://www.amazon.com/gp/feature.html?ie=UTF8&docId=*** 下载 KindleGen。
• 将该目录（含 kindlegen 二进制文件）挂载到容器的 /usr/share/kindlegen。