openpf/openproject

OpenProject Docker镜像文档

镜像概述和主要用途

OpenProject Docker镜像是一个预配置的容器化解决方案，用于快速部署OpenProject项目管理平台。该镜像内置了运行OpenProject所需的全部依赖组件，包括SSHD、Memcached、MySQL服务器、rbenv、Ruby 2.1、Passenger以及OpenProject开发快照，无需手动配置复杂的运行环境，可直接启动使用。

核心功能和特性

• 完整依赖集成：包含SSHD、Memcached、MySQL、Ruby 2.1等所有运行依赖
• 便捷访问：支持通过SSH连接容器进行管理操作
• 灵活配置：可通过环境变量配置邮件服务和外部数据库
• 数据持久化：支持通过数据容器模式实现数据持久化
• 插件扩展：允许自定义插件列表和主题
• 版本更新：支持通过Git拉取代码更新OpenProject版本

使用场景和适用范围

• 快速搭建OpenProject项目管理环境
• 开发和测试环境的快速部署
• 小型团队的项目管理工具部署
• 需要隔离环境的OpenProject实例运行

详细使用方法和配置说明

基本使用

要在主机的80端口启动OpenProject实例：

bash
docker run -p 80:8080 -d openpf/openproject:stable

参数说明：

• -d：后台运行容器并输出容器ID
• -p 80:808：将容器的8080端口映射到主机的80端口

启动后，通过以下URL访问OpenProject：

http://127.0.0.1:8080

获取容器Shell

容器同时运行SSH服务（默认端口22），需映射SSH端口以连接：

1. 启动容器时映射SSH端口：

bash
docker run -p 8080 -p 20 -d openpf/openproject:stable

2. 使用docker port命令查看本地映射端口：

bash
docker port <容器ID> 22

3. 通过SSH连接容器：

bash
ssh -p <映射端口> openproject@localhost

注意：openproject用户的密码在镜像构建过程中随机生成，构建时会显示类似ssh openproject password: <随机密码>的信息。

数据持久化

OpenProject的数据（数据库、上传文件等）默认存储在容器内部，建议采用"数据容器"模式实现持久化：

需持久化的关键路径：

• RAILS_ROOT/files：上传文件存储目录
• /var/lib/mysql：MySQL数据库目录
• RAILS_ROOT/log：日志文件目录
• 本地代码仓库目录（如配置了本地仓库）

实现方法参考数据容器模式，通过创建专用数据容器并挂载到应用容器。

更新OpenProject代码

通过SSH连接容器后执行以下命令更新代码：

bash
# 进入OpenProject目录
cd <OpenProject安装目录>
# 拉取最新代码
git pull
# 安装依赖
bundle install
# 数据库迁移
bundle exec rake db:migrate
# 预编译静态资源
bundle exec rake assets:precompile

更新完成后重启容器使更改生效。更新前请务必备份数据。

邮件配置

默认配置不发送邮件，需通过环境变量配置SMTP服务：

bash
docker run -d \
  -p 8080:8080 -p <本地端口>:22 \
  -e "EMAIL_DELIVERY_METHOD=smtp" \
  -e "SMTP_ADDRESS=smtp.gmail.com" \
  -e "SMTP_PORT=587" \
  -e "SMTP_DOMAIN=smtp.gmail.com" \
  -e "SMTP_AUTHENTICATION=plain" \
  -e "SMTP_ENABLE_STARTTLS_AUTO=true" \
  -e "SMTP_USER_NAME=your_email@gmail.com" \
  -e "SMTP_PASSWORD=your_password" \
  openpf/openproject

配置后需在OpenProject界面中进一步设置：模块 -> 管理 -> 设置 -> 邮件通知。

OpenProject插件管理

镜像已包含部分插件，可通过修改files/Gemfile.plugins文件自定义插件列表（需在构建镜像前修改）。

使用外部数据库

通过DATABASE_URL环境变量配置外部数据库（支持MySQL和PostgreSQL）：

bash
docker run -d \
  -p 8080:8080 -p <本地端口>:22 \
  -e "DATABASE_URL=mysql2://user:password@host/db_name" \
  openpf/openproject

• MySQL数据库URL格式：mysql2://user:password@host/db_name
• PostgreSQL数据库URL格式：postgres://user:password@host/db_name

注意：外部数据库需预先创建，用户需有足够权限，且数据库 schema 需通过bundle exec rake db:migrate同步。

镜像构建

从源码构建镜像：

bash
docker build --rm -t openpf/openproject git://github.com/opf/openproject.git

注意：部分Docker环境可能需要在命令前添加sudo。

期望功能

• 首次登录强制管理员修改密码
• 预设示例数据
• 开发环境专用镜像
• 非sudo用户SSH登录
• 减小镜像体积

贡献方式

• 提交Pull Request
• 在bug跟踪系统创建issue
• 在论坛参与讨论

许可证

本作品采用GPLv3许可 - 详见COPYRIGHT.md。