CKAN 官方 Docker 镜像文档

1. 镜像概述与主要用途

本仓库包含 CKAN 的官方 Docker 镜像。这些镜像分为 base（生产环境）和 dev（开发环境）两种类型，旨在简化 CKAN 平台的部署与开发流程。

镜像通常通过 Docker Compose 与其他服务（如数据库、Solr 等）配合使用，共同构成完整的 CKAN 平台。官方推荐的 CKAN Docker 部署方案可参考：ckan-docker。

问题反馈或代码贡献请提交至 GitHub 仓库。

2. 版本与标签说明

以下为支持的 CKAN 版本、镜像类型及对应的 Docker 标签信息。镜像类型分为 base（生产用）和 dev（开发用），两者基于不同的基础镜像构建。

额外标签格式

除上述标签外，每个发布版本还包含以下格式的标签：
ckan/ckan-base:{major_version}-py{python_version}-{release_name}
（例如：ckan/ckan-base:2.11-py3.10-release1）

3. 核心功能与特性

• 双镜像类型：提供 base（生产优化，精简依赖）和 dev（含开发工具，如代码热重载）两种镜像，满足不同场景需求。
• 多版本支持：覆盖 CKAN 稳定版本（2.9.x、2.10.x、2.11.x）及开发分支（master），适配 legacy 系统与最新功能。
• 标准化基础镜像：新版统一基于 Python 官方 slim 镜像（Debian bookworm）构建，确保兼容性与安全性；旧版基于 Alpine 的镜像已弃用。
• 清晰标签策略：标签包含 CKAN 版本、Python 版本及发布名称，便于版本管理与追溯。

4. 使用场景与适用范围

5. 使用方法

5.1 镜像拉取

通过以下命令拉取指定版本的镜像：

# 拉取 CKAN 2.11.x base 镜像（生产用）
docker pull ckan/ckan-base:2.11

# 拉取 CKAN 2.11.x dev 镜像（开发用）
docker pull ckan/ckan-dev:2.11

5.2 Docker Compose 部署示例

CKAN 运行依赖 PostgreSQL、Solr 等服务，官方推荐通过 Docker Compose 部署。完整配置请参考 ckan-docker，以下为基础示例片段：

# docker-compose.yml（简化版）
version: '3'

services:
  ckan:
    image: ckan/ckan-base:2.11
    ports:
      - "5000:5000"
    environment:
      - CKAN_SITE_URL=http://localhost:5000
      - CKAN__DATABASE__URL=postgresql://ckan_user:ckan_pass@db:5432/ckan_db
      - CKAN__SOLR__URL=[***]
    depends_on:
      - db
      - solr

  db:
    image: postgres:13
    environment:
      - POSTGRES_USER=ckan_user
      - POSTGRES_PASSWORD=ckan_pass
      - POSTGRES_DB=ckan_db

  solr:
    image: ckan/solr:latest
    volumes:
      - solr_data:/opt/solr/server/solr/ckan/data

volumes:
  solr_data:

5.3 开发环境使用

使用 dev 镜像进行插件开发时，可通过挂载本地代码目录实现热更新：

docker run -it --rm \
  -v $(pwd)/my-ckan-plugin:/app/my-ckan-plugin \
  -e CKAN_SITE_URL=http://localhost:5000 \
  ckan/ckan-dev:2.11

6. 注意事项

• 弃用提示：所有基于 Alpine 的镜像已弃用，新版本均基于 Python/Debian 构建，建议迁移至表格中标注的非弃用标签。
• 生产环境禁忌：master 标签镜像为每日构建的开发版本，包含未稳定功能，禁止用于生产环境。
• 版本支持：旧版 CKAN（如 2.9.x 以下）可能仍有镜像标签，但根据 CKAN 发布政策，这些版本不再提供官方支持。
• 标签选择：生产环境建议使用具体版本标签（如 2.11.1），避免使用浮动标签（如 2.11），防止意外更新导致兼容性问题。