datacite/docker-handle

Handle Server Docker镜像文档

镜像概述

本镜像为Handle Server的容器化版本，用于在Docker环境中快速部署和运行Handle系统。Handle系统是一个分布式命名系统，主要功能是创建、解析和管理持久化数字资源标识（Handles），确保数字资源（如文献、数据集、媒体文件等）的长期可访问性。通过Docker容器化，简化了Handle Server的安装、配置和跨环境部署流程。

核心功能与特性

核心功能

• 支持Handle标识的全生命周期管理：创建、注册、更新、解析和删除
• 提供Handle解析服务，响应客户端的Handle查询请求
• 支持Handle记录的权限控制与访问策略配置
• 兼容Handle System协议规范（RFC 3650、RFC 3651）

特性

• 容器化部署：无需手动安装依赖，通过Docker命令一键启动
• 配置灵活：支持通过环境变量、配置文件挂载自定义服务器参数
• 数据持久化：可通过卷挂载实现配置数据、Handle记录和日志的持久化存储
• 网络隔离：通过Docker网络配置实现端口映射与访问控制
• 跨平台兼容：支持在任何运行Docker的Linux、Windows或macOS环境中运行

使用场景

• 学术机构：管理科研论文、数据集等学术资源的持久化标识
• 数字图书馆：为电子资源（电子书、期刊文章）提供永久访问链接
• 数据仓储：为数据集分配唯一标识，支持长期数据引用与共享
• 出版行业：管理期刊文章、预印本的持久化DOI-like标识
• 企业应用：内部系统数字资产（如文档、代码库、媒体文件）的统一标识管理

使用方法与配置说明

前提条件

• 已安装Docker Engine（20.10+）
• 已安装Docker Compose（可选，用于多容器部署）
• 网络环境支持TCP/UDP端口访问（默认Handle服务端口：8000/TCP，8000/UDP）

获取镜像

bash
# 拉取最新版本镜像（假设镜像仓库为handle-server）
docker pull handle-server:latest

# 或指定版本标签
docker pull handle-server:9.3.0

快速启动容器

基础运行命令

bash
docker run -d \
  --name handle-server \
  -p 8000:8000/tcp \
  -p 8000:8000/udp \
  -v handle-data:/opt/handle/data \
  -v handle-config:/opt/handle/config \
  -e ADMIN_EMAIL="admin@example.com" \
  -e SERVER_NAME="handle.example.com" \
  handle-server:latest

参数说明

• -p 8000:8000/tcp：映射Handle服务器TCP端口（用于客户端请求）
• -p 8000:8000/udp：映射Handle服务器UDP端口（用于服务器间通信）
• -v handle-data:/opt/handle/data：挂载数据卷，持久化Handle记录存储
• -v handle-config:/opt/handle/config：挂载配置卷，持久化服务器配置文件
• -e ADMIN_EMAIL：管理员***（用于系统通知和证书配置）
• -e SERVER_NAME：服务器域名或IP（用于生成服务器标识）

高级配置

环境变量配置

配置文件挂载

如需自定义Handle Server核心配置（如handle-server.conf、siteinfo.xml），可将本地配置文件目录挂载至容器内/opt/handle/config：

bash
docker run -d \
  --name handle-server \
  -p 8000:8000/tcp -p 8000:8000/udp \
  -v /path/to/local/config:/opt/handle/config \
  -v handle-data:/opt/handle/data \
  handle-server:latest

Docker Compose配置示例

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  handle-server:
    image: handle-server:latest
    container_name: handle-server
    restart: always
    ports:
      - "8000:8000/tcp"
      - "8000:8000/udp"
    environment:
      - ADMIN_EMAIL=admin@institution.example
      - SERVER_NAME=handle.institution.example
      - STORAGE_TYPE=bdb
      - LOG_LEVEL=INFO
    volumes:
      - handle-config:/opt/handle/config
      - handle-data:/opt/handle/data
      - handle-logs:/opt/handle/logs
    networks:
      - handle-network

volumes:
  handle-config:
  handle-data:
  handle-logs:

networks:
  handle-network:
    driver: bridge

启动服务：

bash
docker-compose up -d

验证部署

部署完成后，通过以下方式验证服务运行状态：

1. 查看容器日志：docker logs -f handle-server，确认无错误信息
2. 测试Handle解析：使用Handle客户端工具发送解析请求，如：

   bash
   hdl-resolve -s http://localhost:8000 12345/TEST123
   

   （注：首次部署需先创建测试Handle标识）
3. 检查端口监听：netstat -tulpn | grep 8000，确认TCP/UDP端口已监听

注意事项

• 生产环境建议使用持久化存储卷（volumes）确保数据不丢失
• 高可用部署需配置Handle Server集群，通过共享存储或数据库实现数据同步
• 定期备份handle-data卷数据，防止数据损坏
• 根据实际负载调整MAX_CONCURRENT_REQUESTS等性能参数