intranda/goobi-viewer-theme-reference

Goobi viewer - Reference Theme 镜像文档

镜像概述和主要用途

Goobi viewer - Reference Theme镜像是基于Goobi viewer数字图书馆系统的官方参考主题构建的Docker镜像，提供预配置的默认界面解决方案。该镜像集成完整的用户界面组件、交互逻辑和视觉样式，可直接与Goobi viewer后端服务对接，旨在帮助用户快速部署具备专业级展示能力的数字文化遗产访问平台。

主要用途包括：

• 快速搭建数字图书馆前端展示界面
• 作为自定义主题开发的基础模板和参考示例
• 演示Goobi viewer的核心界面功能与交互流程
• 降低文化机构部署数字展示平台的技术门槛

核心功能和特性

核心功能

• 完整界面组件：包含导航栏、搜索框、内容列表、详情页、图片查看器等数字图书馆必备界面元素
• 后端集成：预配置与Goobi viewer后端的API通信机制，支持元数据检索、内容加载和用户权限验证
• 内容展示：支持多种文化遗产内容类型（书籍、手稿、图片、音频等）的标准化展示
• 搜索功能：集成基础搜索、高级搜索和过滤功能，支持全文检索与元数据筛选

主要特性

• 响应式设计：自适应桌面、平板和移动设备，确保多端访问体验一致
• 即开即用：无需手动配置基础主题文件，部署后即可投入使用
• 可定制化：支持通过文件挂载覆盖CSS样式、HTML模板和静态资源，实现界面个性化
• 国际化支持：内置多语言界面框架，支持内容与界面元素的多语言展示
• 性能优化：包含资源压缩、缓存策略和懒加载机制，提升页面加载速度

使用场景和适用范围

使用场景

• 文化机构（博物馆、档案馆、图书馆）部署数字文化遗产在线展示平台
• 学术机构构建特色馆藏（如古籍、地方文献）的数字化访问系统
• 开发者基于参考主题进行定制化界面开发与测试
• 教育机构搭建数字教学资源库的前端展示层

适用范围

• 需快速上线数字展示平台且技术资源有限的中小型文化机构
• 希望基于标准化模板开发自定义主题的开发团队
• 需要演示数字图书馆系统功能的展览或项目试点
• 对界面美观度和用户体验有基础要求的数字文化项目

使用方法和配置说明

前提条件

• 已安装Docker Engine（推荐20.10+版本）
• 已部署Goobi viewer后端服务（参考Goobi viewer后端部署文档）
• 容器网络环境需支持前端镜像与后端服务的通信（同一Docker网络或跨主机可访问）

基本部署示例

使用docker run部署

bash
docker run -d \
  --name goobi-viewer-reference-theme \
  -p 8080:80 \
  --network goobi-network \
  -e GOOBI_VIEWER_BACKEND_URL=http://goobi-viewer-backend:8080 \
  -v ./custom-assets:/var/www/html/themes/custom \
  -v ./config:/var/www/html/config \
  intranda/goobi-viewer-reference-theme:latest

参数说明

• -p 8080:80：将容器内80端口映射到主机8080端口，用于前端访问
• --network goobi-network：连接至与后端服务相同的Docker网络（需提前创建）
• -e GOOBI_VIEWER_BACKEND_URL：指定后端服务URL（需替换为实际后端地址）
• -v ./custom-assets:/var/www/html/themes/custom：挂载自定义资源目录，用于覆盖主题样式
• -v ./config:/var/www/html/config：挂载配置文件目录，用于自定义系统参数

环境变量配置

自定义主题开发

基于该镜像进行主题定制的基本流程：

1. 从Goobi viewer官方文档获取主题开发规范
2. 在本地创建主题目录（如./custom-theme），按以下结构组织文件：

   custom-theme/
   ├── css/           # 自定义样式文件（覆盖默认CSS）
   ├── templates/     # 自定义HTML模板（覆盖默认页面结构）
   ├── images/        # 自定义图片资源（如logo、背景图）
   └── js/            # 自定义JavaScript脚本（扩展交互功能）
   

3. 将自定义目录挂载至容器/var/www/html/themes/custom
4. 设置环境变量THEME_ACTIVE=custom启用自定义主题
5. 重启容器使配置生效，通过浏览器预览效果并调试

注意事项

• 该镜像需配合Goobi viewer后端服务使用，确保后端已正确配置元数据索引和内容存储
• 生产环境部署时，建议：
  • 启用HTTPS并配置SSL证书（通过挂载证书文件或使用反向代理）
  • 限制容器资源使用（通过--memory和--cpus参数）
  • 配置持久化存储（如数据库、媒体文件需使用外部卷挂载）
• 自定义主题时，需确保文件路径和命名与默认主题保持一致，避免功能异常
• 版本更新时，建议先备份自定义主题文件，避免升级覆盖配置