yalelibraryit/dc-blacklight

Digital Collections Blacklight Docker镜像文档

1. 镜像概述

本Docker镜像用于快速部署基于Blacklight框架的数字馆藏发现系统。Blacklight是一个开源的Ruby on Rails引擎，专为构建数字资源发现平台设计，广泛应用于文化遗产机构。该镜像封装了Blacklight运行所需的依赖环境，简化了数字馆藏系统的部署流程，支持快速搭建具备专业检索能力的数字资源访问平台。

2. 核心功能与特性

2.1 核心功能

• 专业检索系统：集成Apache Solr搜索引擎，支持全文检索、字段检索及高级筛选功能
• 数字资源展示：提供标准化的元数据展示界面，支持多种数字资源格式（如图像、文本、音频等）
• 用户交互体验：包含结果排序、保存检索、浏览历史等用户功能
• 响应式设计：适配桌面端与移动端，确保多设备访问体验

2.2 主要特性

• 开箱即用：预配置基础Blacklight环境，无需手动安装依赖
• 灵活定制：支持通过环境变量和挂载配置文件自定义系统参数
• 版本稳定：基于官方Ruby镜像构建，确保运行环境的稳定性
• 扩展性强：可与外部Solr服务、数据库集成，支持大规模数字资源管理

3. 使用场景

本镜像适用于需要构建专业数字资源访问平台的机构，包括但不限于：

• 图书馆：管理和展示电子图书、期刊论文等数字馆藏
• 档案馆：提供档案文件、历史文献的数字化访问服务
• 博物馆：展示文物图片、音频解说等数字展览资源
• 研究机构：构建专题学术资源库，支持科研人员检索与利用

4. 使用方法与配置说明

4.1 基本部署（Docker Run）

bash
docker run -d \
  --name digital-collections-blacklight \
  -p 80:3000 \
  -e SOLR_URL=http://solr:8983/solr/blacklight-core \
  -e DATABASE_URL=postgresql://user:password@db:5432/blacklight \
  -e SECRET_KEY_BASE=your_secret_key \
  -v ./config:/app/config \
  -v ./data:/app/public/data \
  digital-collections-blacklight

4.2 Docker Compose配置示例

yaml
version: '3'
services:
  blacklight:
    image: digital-collections-blacklight
    ports:
      - "80:3000"
    environment:
      - SOLR_URL=http://solr:8983/solr/blacklight-core
      - DATABASE_URL=postgresql://user:password@db:5432/blacklight
      - SECRET_KEY_BASE=your_secret_key
      - RAILS_ENV=production
    volumes:
      - ./config:/app/config
      - ./public/data:/app/public/data
    depends_on:
      - solr
      - db

  solr:
    image: solr:8
    volumes:
      - solr_data:/var/solr
    command: solr-precreate blacklight-core

  db:
    image: postgres:13
    volumes:
      - db_data:/var/lib/postgresql/data
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=blacklight

volumes:
  solr_data:
  db_data:

4.3 环境变量配置

4.4 数据持久化

为确保配置和用户数据不丢失，建议挂载以下目录：

• /app/config：存放自定义配置文件（如blacklight.yml、catalog_controller.rb）
• /app/public/data：存储上传的数字资源文件
• /app/db：数据库文件（当使用SQLite时）

5. 自定义与扩展

5.1 界面定制

通过挂载/app/app/views目录替换默认视图模板，或修改/app/app/assets目录下的CSS/JS文件自定义界面样式。

5.2 元数据字段配置

编辑挂载的/app/config/blacklight.yml文件，添加或修改元数据字段定义，示例：

yaml
default: &default
  solr:
    url: <%= ENV['SOLR_URL'] %>
    document_model: SolrDocument
  search_fields:
    title:
      label: 'Title'
      solr_parameters:
        qf: 'title_t^5'
    author:
      label: 'Author'
      solr_parameters:
        qf: 'author_t^3'

5.3 集成外部服务

可通过环境变量配置与外部认证服务（如LDAP、OAuth）集成，或对接机构内部的用户管理系统，实现统一身份认证。