kspckan/netkan

Netkan Utilities Docker镜像文档

镜像概述

Netkan Utilities Docker镜像是用于KSP-CKAN（Kerbal Space Program - Comprehensive Kerbal Archive Network）自动化元数据索引服务的专用工具集容器化实现。该镜像基于Netkan工具集构建，专注于KSP模组元数据的解析、处理与索引生成，支持自动化元数据管理流程，为CKAN仓库提供可靠的元数据支持。

核心功能与特性

• 元数据解析：支持解析KSP模组的.netkan格式元数据文件，提取模组基本信息、版本历史、依赖关系等核心数据
• 索引生成：自动生成标准化元数据索引，优化CKAN客户端的模组搜索与获取效率
• 自动化处理：支持定时任务或事件触发式元数据处理流程，减少人工干预
• 兼容性验证：内置元数据格式校验机制，确保生成的索引符合CKAN规范
• 轻量级设计：基于精简基础镜像构建，资源占用低，部署便捷

使用场景与适用范围

• KSP-CKAN官方或第三方镜像源的元数据维护
• KSP模组元数据的自动化采集、处理与更新
• 自定义CKAN仓库搭建中的元数据索引服务部署
• 模组开发者元数据格式验证与测试环境
• 大规模KSP模组元数据批量处理任务

使用方法

基础运行命令

bash
docker run -d \
  --name netkan-utilities \
  -v /path/to/netkan-files:/app/netkan \  # 挂载本地元数据文件目录
  -v /path/to/index-output:/app/output \  # 挂载索引输出目录
  netkan-utilities:latest

Docker Compose配置示例

yaml
version: '3'
services:
  netkan:
    image: netkan-utilities:latest
    container_name: netkan-service
    volumes:
      - ./netkan-data:/app/netkan  # 本地元数据文件目录
      - ./index-results:/app/output  # 索引结果输出目录
    restart: unless-stopped
    environment:
      - LOG_LEVEL=info  # 日志级别：debug, info, warn, error
      - UPDATE_INTERVAL=3600  # 自动更新间隔（秒），0为禁用

配置说明

环境变量

数据卷挂载

• 元数据输入目录：存放.netkan格式元数据文件，需通过-v /local/path:/app/netkan挂载
• 索引输出目录：生成的索引文件存放位置，需通过-v /local/path:/app/output挂载

命令参数

可通过容器运行命令追加参数调整行为：

• --force：强制重新生成所有索引（忽略缓存）
• --clean：生成索引前清理输出目录
• --validate：仅执行元数据格式验证，不生成索引

示例：

bash
docker run netkan-utilities:latest --force --validate