pkpofficial/ojs

OJS (Open Journal Systems) - PKP - 容器/Docker

Open Journal Systems (OJS)是一款期刊管理与发布系统，由Public Knowledge Project通过联邦资助开发，旨在扩大和改善研究成果的获取途径。

本仓库中的镜像最初基于Alpine Linux构建，但从3.5版本开始迁移到Debian镜像。可能包含其他额外变更。

仓库中的镜像有多个变体（参见版本）。本项目由https://github.com/marcbria%E7%BB%B4%E6%8A%A4%E3%80%82

镜像在Linux系统中构建和测试，理论上可在Windows上运行。目前暂未提供ARM架构镜像，因此无法在最新的Mac电脑上使用。

=========================================================================================================================
== 警告
=========================================================================================================================
== 
== 我们正处于重构过程中，因此本描述可能已过时，部分信息可能不准确。
== 最新文档请始终参考 [pkp/containers](https://github.com/pkp/containers) 仓库：
== 
== - https://github.com/pkp/containers/blob/main/README.md
== - https://github.com/pkp/containers/blob/main/docs/easyOJS.md
=========================================================================================================================

关于标签命名

基本原则是“Docker镜像的名称与OJS官方仓库中的标签名称相同”，但带有应用前缀。即，如果需要拉取OJS 3.3.0-17版本（官方标签为3_3_0-17），只需拉取pkpofficial/ojs-3_3_0-17镜像。

同时维护latest、lts和stable标签的别名，更新规则如下：

重要： 我们仅对刚发布的镜像以及标记为latest和LTS的版本进行安全检查。

镜像命名规则仍在讨论中（如LAMP环境需发布安全补丁时如何处理、是否提供最新镜像、如何处理Web服务器/PHP/使用变体等）。可在上述文档中评论或参与讨论。

如何使用

快速开始

确保已正确安装docker和docker-compose。

bash
git clone https://github.com/pkp/containers.git journalName && cd journalName
rm docs templates -Rf                               # 删除生产环境中无用的文件夹
vim .env                                            # 根据需要设置环境变量（OJS版本、端口、URL等）
source .env && wget "https://github.com/pkp/${PKP_TOOL}/raw/${PKP_VERSION}/config.TEMPLATE.inc.php" -O ./volumes/config/pkp.config.inc.php
sudo chown 33:33 ./volumes -R && sudo chown 999:999 ./volumes/db -R  # 确保文件夹权限正确
docker compose up -d
# 访问新站点并完成安装（数据库访问凭据见步骤5）

详细说明

完整说明请参考 "https://github.com/pkp/containers/blob/main/docs/easyOJS.md#extended-version-under-review" 文档。

版本

不同OJS版本与不同PHP版本（5至8）组合。未来计划添加不同Web服务器（Apache HTTP Server、nginx）的变体。

注意： 目前并非所有组合都可用！我们主要专注于Apache2。欢迎提交PR。

所有版本标签可在 https://hub.docker.com/r/pkpofficial/ojs/tags/ 查看。

（若标签中未提及Web服务器，则默认使用Apache）

环境变量

镜像支持以下环境变量：

注意： OJS_CLI_INSTALL和证书功能仍在开发中。

特殊卷

Docker内容默认是临时的，但某些数据需在容器重启后持久化（如数据库内容、上传文件、插件开发文件等）。默认版本文件夹中包含./volumes目录结构（默认禁用），需在docker-compose.yml中取消卷挂载注释并正确配置文件夹。

本镜像使用相对路径的“绑定卷”，便于明确数据存储位置。使用前需确保存储文件夹存在且权限正确，可运行以下命令设置权限：

bash
$ chown 33:33 ./volumes -R            # Debian容器内www-data用户（uid 33/gid 33）
$ chown 999:999 ./volumes/db -R
$ chown 999:999 ./volumes/logs/db -R  # MariaDB用户（uid 999/gid 999）

内置脚本

Dockerfile在/usr/local/bin中包含以下脚本，用于简化常见操作：

部分脚本仍处于测试阶段，使用时需注意。可通过docker compose exec在容器外调用：

bash
$ docker compose exec app /usr/local/bin/pkp-variable session_check_ip Off

或使用docker exec：

bash
$ docker exec -it pkp_app_journalname /usr/local/bin/pkp-variable session_check_ip Off

升级OJS

1. 停止旧版本容器（如"pkpofficial/ojs:2_4_8-5"）：

   bash
   docker compose stop
   

2. 在.env文件中设置新版本（或直接修改docker-compose.yml），将旧版本（如2_4_5-2）替换为新版本（如3_2_1-4）。

3. 拉取并启动新容器：

   bash
   $ docker compose pull
   $ docker compose up -d
   

4. 运行升级脚本：

   bash
   $ docker compose up php tools/upgrade.php check && docker compose up php tools/upgrade.php upgrade 
   

提示： 可通过docker ps -a | grep pkp_app查看OJS容器名称。

警告： 直接升级至最新稳定版需根据初始版本，推荐路径：2.x > 2.4.8-5 > 3.1.2-4 > 3.2.1-4 > 3.3.x-x

Apache2

目前仅支持Apache2，配置文件和卷均针对Apache2设计。

修改配置的简便方法

无需构建本地镜像，可使用Docker Hub镜像并在docker-compose.yml中映射配置文件。例如，创建./volumes/config/php.custom.ini并取消对应卷注释即可自定义PHP设置。

RESTful URL（简洁URL）

默认启用RESTful URL，Apache已配置，无需在URL中使用index.php。

SSL

Apache启动时会检查SSL证书有效性及CN是否匹配SERVERNAME，若不匹配则生成新证书。可通过卷挂载自定义证书（见docker-compose.yml）。

注意： 此功能正在审核中，未来可能变更。

外部SSL服务（SSL卸载）

若前端有外部服务处理SSL连接，需在<VirtualHost *:80> section中添加PassENV HTTPS到ojs.conf。

如何贡献

更新compose配置和Dockerfile

克隆项目并提交PR，贡献新Dockerfile或docker-compose配置。版本文件基于templates目录下的模板生成，可通过build.sh脚本重新生成：

bash
# 生成特定版本
$ ./build.sh 3_1_2-4

# 生成所有版本
$ ./build.sh

添加新堆栈（如nginx）

1. 确保版本号在versions.list中。
2. 在templates目录中创建所需文件（Dockerfile模板、docker-compose模板、配置文件等）。
3. 编辑build.sh添加新堆栈（如webServers=( 'apache' 'nginx' )）。
4. 运行build.sh重新生成版本。
5. 测试并提交PR（仅包含build.sh和模板文件，忽略versions目录）。

故障排除

• Mac问题：新Mac的ARM架构不支持，可能存在互斥锁设置问题，参考相关链接。
• Windows问题：PowerShell不兼容wget变量，需手动修改配置文件获取正确版本的config.TEMPLATE。
• nginx镜像：目前未提供，欢迎贡献。
• 插件处理：可通过卷挂载或自定义Dockerfile集成插件。
• 路线图：优先解决Mac镜像问题、自动化构建、基于Containers for PKP文档创建新镜像。

许可证

GPL3 © https://github.com/pkp