infrascielo/opac

SciELO - 在线公共访问目录 (OPAC) Docker镜像

镜像概述和主要用途

本镜像为SciELO在线公共访问目录(OPAC)的Docker化部署方案，用于提供学术资源的在线查询与访问服务。支持开发环境和生产环境部署，可通过配置文件或环境变量自定义系统参数，包含完整的容器化配置及测试脚本，便于快速搭建和维护OPAC系统。

核心功能和特性

• 多环境支持：提供开发环境（Dockerfile-dev）和生产环境（Dockerfile）的镜像构建配置
• 灵活配置：通过环境变量或配置文件自定义系统参数，如旧网站链接、提示消息、数据库连接等
• 完整容器化：包含多个docker-compose配置文件，支持生产、CI/Travis及开发环境的容器编排
• 测试支持：提供单元测试（make test）和覆盖率报告（make test_coverage）脚本
• 数据导入：支持通过Fixtures导入开发环境测试数据，快速搭建演示环境

使用场景和适用范围

适用于学术机构、图书馆等需要部署SciELO OPAC系统的场景，可用于：

• 开发团队搭建本地开发环境
• 生产环境部署公共访问的OPAC系统
• CI/CD流程中自动化构建和测试

详细的使用方法和配置说明

安装与配置

GitHub Wiki提供了不同环境的安装配置指南：

• https://github.com/scieloorg/opac/wiki/Configura%C3%A7%C3%A3o-e-instala%C3%A7%C3%A3o
• https://github.com/scieloorg/opac/wiki/Configura%C3%A7%C3%A3o-e-instala%C3%A7%C3%A3o-%28ambiente-de-produ%C3%A7%C3%A3o%29-Gunicorn
• https://github.com/scieloorg/opac/wiki/Configura%C3%A7%C3%A3o-e-instala%C3%A7%C3%A3o-%28ambiente-de-produ%C3%A7%C3%A3o%29-Gunicorn

网站配置指南

完整配置指南及通过配置文件或环境变量调整参数的方法，可参考https://github.com/scieloorg/opac/wiki/Configura%C3%A7%C3%A3o-padr%C3%A3o-e-vari%C3%A1veis-de-ambiente%E3%80%82

常用自定义配置示例：

• 在网站首页显示旧版网站链接：PREVIOUS_WEBSITE_URI=https://old.scielo.br
• 在网站首页显示多语言提示消息：

  ALERT_MSG_PT=Novo portal pode conter incorreções
  ALERT_MSG_EN=New portal may contain inaccuracies
  ALERT_MSG_ES=Nuevo portal puede contener incorrecciones
  

Docker相关文件说明

测试执行方法

• 运行单元测试：make test
• 生成覆盖率报告：make test_coverage

开发环境Docker安装步骤

通过项目根目录的Dockerfile-dev和docker-compose-dev.yml配置，快速搭建开发环境：

1. 构建OPAC镜像：make dev_compose_build
2. 启动容器：make dev_compose_up
3. 访问应用：浏览器打开http://localhost（macOS用户需使用docker-machine ip获取的IP）
4. 查看日志：make dev_compose_logs
5. 停止容器：make dev_compose_stop
6. 进入容器终端：make dev_compose_exec_shell_webapp

Fixtures数据导入（开发环境）

通过SciELO提供的fixtures文件填充测试数据：

1. 确保开发环境已启动：make dev_compose_up
2. 下载fixtures文件（轻量版含4种期刊）：
   wget https://minio.scielo.br/dev/fixtures/opac_br.zip
   或完整版：wget https://minio.scielo.br/dev/fixtures/opac_br_full.zip
3. 解压文件：unzip opac_br.zip（生成含.bson、.json、.sqlite及media目录的opac_br文件夹）
4. 进入目录：cd opac_br
5. 恢复MongoDB数据：
   mongorestore --host=localhost --port=27017 -d=opac --dir .
6. 复制media目录到项目根目录的data目录（默认映射到OPAC应用）
7. 复制opac.sqlite到项目根目录的data目录
8. 配置docker-compose-dev.yml参数：

   yaml
   environment:
     - OPAC_SSM_DOMAIN=minio.scielo.br
     - OPAC_SSM_PORT=443
     - OPAC_SSM_SCHEME=https
     - OPAC_SSM_XML_URL_REWRITE=False
   

9. 重启容器：make dev_compose_stop && make dev_compose_up

注意：需安装MongoDB数据库工具获取mongorestore；访问文章页面需连接SciELO ***；管理员账号：admin@admin.com，密码：admin。

环境变量配置

完整环境变量列表见项目https://github.com/scieloorg/opac/wiki/Configura%C3%A7%C3%A3o-padr%C3%A3o-e-vari%C3%A1veis-de-ambiente

问题反馈与功能请求

通过https://github.com/scieloorg/opac/issues%E6%8F%90%E4%BA%A4%E9%97%AE%E9%A2%98%E3%80%81Bug%E6%8A%A5%E5%91%8A%E6%88%96%E5%8A%9F%E8%83%BD%E8%AF%B7%E6%B1%82%E3%80%82