scieloorg/opac

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

镜像概述和主要用途

SciELO OPAC (On-line Public Access Catalog) 是一个用于管理和提供学术资源访问的在线目录系统。本Docker镜像提供了便捷的部署方案，支持开发、测试和生产环境，通过容器化方式简化安装配置流程，确保系统在不同环境中的一致性和可移植性。

核心功能和特性

• 多环境支持：提供生产和开发环境专用Docker配置文件
• 灵活配置：通过环境变量或配置文件自定义系统参数，支持多语言提示信息
• 第三方集成：可集成Google Analytics、SciELO Analytics、Dimensions、PlumX等学术分析工具
• 安全特性：支持CSRF保护、会话管理、HTTPS配置等安全功能
• 缓存优化：内置Redis缓存支持，提升系统响应速度
• 邮件通知：支持错误报告、审计日志等邮件通知功能

使用场景和适用范围

• 学术机构：用于构建机构内部或公共的学术资源访问目录
• 开发团队：快速搭建本地开发环境，进行功能开发和测试
• 生产部署：通过Docker Compose实现多容器协同部署，满足生产环境稳定性需求

详细使用方法和配置说明

安装和配置指南

项目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%E4%BB%A5%E4%B8%8B%E6%98%AF%E5%B8%B8%E7%94%A8%E9%85%8D%E7%BD%AE%E7%A4%BA%E4%BE%8B%EF%BC%9A

• 显示旧版网站链接：

  bash
  PREVIOUS_WEBSITE_URI=https://old.scielo.br
  

• 显示首页提示信息（支持多语言）：

  bash
  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相关文件说明

环境变量

完整环境变量列表请参考项目文档，以上为常用关键变量示例。

使用Docker进行开发环境安装

通过以下步骤使用Docker快速搭建开发环境（基于Dockerfile-dev和docker-compose-dev.yml）：

1. 构建镜像：

   bash
   make dev_compose_build
   

2. 启动容器：

   bash
   make dev_compose_up
   

3. 访问应用：

   • 浏览器访问：http://localhost
   • macOS用户需使用Docker机器IP：执行docker-machine ip获取IP后访问

4. 查看日志：

   bash
   make dev_compose_logs
   

5. 停止容器：

   bash
   make dev_compose_stop
   

6. 进入容器终端：

   bash
   make dev_compose_exec_shell_webapp
   

运行测试

• 执行单元测试：

  bash
  make test
  

• 生成测试覆盖率报告：

  bash
  make test_coverage
  

Fixtures使用（开发环境数据填充）

通过以下步骤使用SciELO提供的fixtures填充开发环境数据：

1. 确保开发环境已启动：make dev_compose_up

2. 下载fixtures文件（轻量版或完整版）：

   bash
   # 轻量版（4种期刊）
   wget https://minio.scielo.br/dev/fixtures/opac_br.zip
   # 完整版
   wget https://minio.scielo.br/dev/fixtures/opac_br_full.zip
   

3. 解压文件：

   bash
   unzip opac_br.zip
   cd opac_br
   

4. 恢复MongoDB数据：

   bash
   mongorestore --host=localhost --port=27017 -d=opac --dir .
   

5. 复制媒体文件和SQLite数据库到项目data目录：

   bash
   cp -r media /path/to/repo/data/
   cp opac.sqlite /path/to/repo/data/
   

6. 配置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
   

7. 重启容器：

   bash
   make dev_compose_stop && make dev_compose_up
   

注：需安装MongoDB数据库工具（含mongorestore），且访问部分内容需连接SciELO 。管理员账户默认凭据： / admin。

问题报告与功能请求

如遇问题或需功能增强，请通过https://github.com/scieloorg/opac/issues%E6%8F%90%E4%BA%A4%E5%8F%8D%E9%A6%88%E3%80%82