dockerimages/openproject

OpenProject Docker镜像文档

镜像概述和主要用途

本Docker镜像用于安装和运行OpenProject，包含运行所需的全部依赖组件，如sshd、memcached、MySQL服务器、rbenv、Ruby 2.1、Passenger以及最新的OpenProject开发快照。通过该镜像可快速部署OpenProject项目管理工具，适用于开发、测试或小型生产环境。

核心功能和特性

• 集成完整依赖栈：包含SSH服务、内存缓存、数据库、Ruby环境及应用服务器
• 开箱即用：无需手动配置依赖，启动容器即可使用OpenProject
• 支持SSH访问：可通过SSH连接容器进行管理和维护
• 环境变量配置：支持通过环境变量自定义邮件服务、数据库连接等关键配置
• 灵活扩展：支持使用外部数据库、自定义插件及数据持久化

使用场景和适用范围

• 快速搭建OpenProject测试环境
• 开发环境中快速部署OpenProject实例
• 小型团队或个人项目的项目管理工具部署
• 需要隔离环境的OpenProject应用场景

使用方法和配置说明

基本运行

要在主机的80端口上启动一个新的OpenProject实例：

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

-d标志使Docker在后台启动镜像，并将容器ID输出到标准输出。启动后，可通过以下URL在主机浏览器中访问：

http://127.0.0.1:8080

获取容器Shell访问

OpenProject服务器运行的同时，会启动监听默认22端口的SSH守护进程。要连接到容器，需在启动时映射SSH端口：

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

使用docker port命令查看本地端口与容器22端口的映射关系，然后通过SSH连接：

bash
$ ssh -p <映射端口> openproject@localhost
$ openproject@localhost's password:

注意：openproject账户的密码是在镜像构建过程中随机生成的，构建时会输出类似ssh openproject password: <随机密码>的信息，请记录该密码。

数据持久化

OpenProject的所有数据（数据库、上传文件、日志等）默认存储在容器内部。为确保数据在镜像更新时不丢失，建议采用"数据容器"模式，将关键目录挂载到外部：

需持久化的目录包括：

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

更新OpenProject代码

要升级OpenProject安装，可通过SSH进入容器并执行以下步骤：

bash
# 进入OpenProject目录
cd /path/to/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: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

替换上述示例中的your_email和your_password为实际SMTP账户信息。配置后，还需在OpenProject的模块 -> 管理 -> 设置 -> 邮件通知页面进行进一步设置。

OpenProject插件

镜像已包含部分OpenProject插件，可通过修改files/Gemfile.plugins文件自定义插件列表（添加、移除插件或主题），修改后需重新构建镜像。

使用外部数据库

通过定义DATABASE_URL环境变量可使用外部数据库（支持MySQL和PostgreSQL）：

bash
docker run -d \
  -p 8080:8080 -p 22: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更新。

构建镜像

从GitHub仓库构建镜像：

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

注意：根据Docker安装配置，可能需要在docker命令前添加sudo。

期望功能

• 首次登录时强制管理员修改密码
• 提供示例种子数据
• 开发环境专用镜像及说明
• 支持非sudo用户的SSH登录
• 减小镜像体积

贡献

欢迎通过以下方式贡献：

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

许可证

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