ualbertalib/jupiter

Jupiter Docker镜像文档

镜像概述

Jupiter是一个基于Ruby on Rails的学术资源管理系统，提供完整的Docker化部署方案，支持本地开发环境快速搭建。该镜像集成了PostgreSQL、Redis、Solr等核心依赖服务，可通过docker-compose实现一键部署，适用于开发、测试及UAT环境。

核心功能与特性

• 完整依赖集成：包含Ruby 2.5+、PostgreSQL、Redis、Solr、ImageMagick、Poppler、FFMpeg、Node.js 18.15.0+及Yarn
• 多环境支持：提供开发环境、演示版及生产（UAT）环境配置
• 自动化部署：通过bin/setup脚本实现依赖安装、容器配置、数据库初始化
• 子域名支持：支持通过子域名访问不同功能模块（如era、digitalcollections）
• 批量导入功能：提供基于CSV文件的批量资源导入工具
• 扩展能力：支持病毒检查（ClamAV）、文件表征（FITS）及SAML身份认证集成

使用场景

• 本地开发环境搭建
• 功能测试与系统集成测试
• UAT环境部署与演示
• 学术资源管理系统二次开发

环境要求

• Docker 1.13.0+
• Docker Compose 1.10.0+
• Git
• Ruby 3.1+（本地环境依赖）

安装与使用方法

开发环境部署

步骤1：安装依赖工具

• 安装Docker
• 安装Docker Compose
• 安装Git和Ruby 3.1+

步骤2：获取源码

shell
git clone git@github.com:ualbertalib/jupiter.git
cd jupiter

步骤3：初始化环境

执行以下命令完成依赖安装、容器配置及数据库初始化：

shell
bin/setup

该命令将：

• 安装RubyGems和JavaScript依赖
• 启动PostgreSQL、Redis、Solr容器
• 创建并迁移数据库，导入初始数据
• 清理日志和临时目录

步骤4：启动服务

shell
bin/dev

此命令通过Overmind（或Foreman）启动：

• Rails服务器
• Sidekiq后台任务
• CSS/JS打包服务

步骤5：访问应用

在浏览器中访问：

• 开发环境：http://era.ualberta.localhost:3000

演示版快速部署

步骤1：获取源码

shell
git clone git@github.com:ualbertalib/jupiter.git
cd jupiter

步骤2：启动容器

shell
docker-compose -f docker-compose.demo.yml build
docker-compose -f docker-compose.demo.yml up -d

步骤3：访问应用

在浏览器中访问：http://era.ualberta.localhost:3000

生产环境部署（UAT环境）

步骤1：配置环境变量

shell
cp .env_deployment_sample .env_deployment
vi .env_deployment  # 修改环境变量值

步骤2：启动容器

shell
docker-compose -f docker-compose.production.yml up -d

步骤3：初始化数据库（首次部署）

shell
docker-compose -f docker-compose.production.yml run web rails db:setup

子域名配置

Jupiter依赖子域名访问不同模块，需配置本地hosts文件：

127.0.0.1       era.demo.com
127.0.0.1       digitalcollections.demo.com

或使用替代方案：

• localhost顶级域名：era.ualberta.localhost:3000
• lvh.me服务：era.lvh.me:3000

常用命令

文档生成

shell
# 生成RDoc文档
bundle exec rake rdoc
# 查看文档
open doc/index.html

# 重新生成文档
bundle exec rake rerdoc
open docs/rdoc/index.html

代码风格检查

shell
# Ruby文件
bundle exec rubocop

# ERB文件
bundle exec erblint .

# JavaScript文件
yarn lint

测试执行

shell
# 运行常规测试
bundle exec rails test

# 运行系统测试
bundle exec rails test:system

数据库操作

shell
# 导入初始数据
bundle exec rake db:seed

# 跳过社区logo下载（离线环境）
SKIP_DOWNLOAD_COMMUNITY_LOGOS=1 bundle exec rake db:seed

高级配置

病毒检查与文件表征

• 病毒检查：参考https://github.com/kobaltz/clamby#dependencies%E5%AE%89%E8%A3%85ClamAV
• 文件表征：安装https://github.com/harvard-lts/fits%E5%B9%B6%E7%A1%AE%E4%BF%9D%60fits.sh%60%E5%9C%A8PATH%E4%B8%AD%EF%BC%8C%E9%80%9A%E8%BF%87%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E5%90%AF%E7%94%A8%EF%BC%9A

  shell
  RUN_FITS_CHARACTERIZATION=1 bin/dev
  

SAML身份认证

1. 更新secrets.yml和omniauth.rb配置
2. 生成SAML证书/密钥
3. 提供服务提供商元数据（访问http://era.ualberta.localhost:3000/auth/saml/metadata获取）

批量导入

通过CSV文件批量导入资源：

shell
rails jupiter:batch_ingest_items["/path/to/your/file.csv"]

CSV模板参考Google Sheets示例

常见问题

容器日志查看

shell
# 查看所有容器日志
docker-compose logs

# 查看指定容器日志（如web）
docker-compose logs web

端口冲突解决

若Postgres端口3306冲突，停止本地Postgres服务：

shell
# Ubuntu示例
sudo service postgresql stop

文件权限问题

切换Docker与本地开发时可能出现权限问题，删除相关文件：

shell
sudo rm -rf /tmp/pids/