kobotoolbox/enketo-express-extra-widgets

Enketo Express Extra Widgets 镜像文档

镜像概述和主要用途

Enketo Express Extra Widgets镜像是Enketo Express的定制版本，在标准Enketo Express基础上内置了额外的小部件（widgets）。Enketo Express是一款用于渲染和提交在线表单的开源工具，广泛与KoboToolbox等表单收集平台配合使用。本镜像通过添加额外小部件扩展了表单交互能力，但这些小部件需在配置文件中显式启用才能生效，适用于需要增强表单功能的场景。

核心功能和特性

• 基于Enketo Express核心：保留Enketo Express的标准功能，包括表单渲染、数据提交、离线支持等
• 内置额外小部件：集成额外的交互小部件，扩展表单设计可能性（如高级选择器、自定义输入控件等）
• 可配置启用机制：额外小部件需通过配置文件显式启用，避免不必要的功能冗余，提升灵活性
• 兼容性保障：与标准Enketo Express接口兼容，可无缝替换标准镜像使用

使用场景和适用范围

• KoboToolbox用户：需要为Kobo表单添加非标准交互元素的用户
• 高级表单开发：设计包含自定义输入逻辑、复杂交互组件的在线表单
• 企业级表单需求：需扩展标准表单功能以满足特定业务流程的组织或项目
• Enketo生态扩展：希望在不修改源码的情况下增强Enketo功能的开发者

使用方法和配置说明

获取镜像

可通过以下方式获取镜像（具体路径需根据实际仓库调整）：

bash
docker pull kobotoolbox/enketo-express-extra-widgets:latest

或从源码构建：

bash
git clone https://github.com/kobotoolbox/enketo-express-extra-widgets.git
cd enketo-express-extra-widgets
docker build -t enketo-express-extra-widgets .

运行容器

基础运行命令

bash
docker run -d \
  --name enketo-extra-widgets \
  -p 8005:8005 \
  -v $(pwd)/config.json:/srv/enketo/config.json \
  kobotoolbox/enketo-express-extra-widgets:latest

Docker Compose示例

yaml
version: '3'
services:
  enketo:
    image: kobotoolbox/enketo-express-extra-widgets:latest
    container_name: enketo-extra-widgets
    ports:
      - "8005:8005"
    volumes:
      - ./config.json:/srv/enketo/config.json
    environment:
      - NODE_ENV=production
    restart: unless-stopped

关键配置说明

启用额外小部件

核心配置文件为config.json，需在此文件中显式启用额外小部件。标准配置路径为容器内/srv/enketo/config.json，建议通过 volumes 挂载本地配置文件进行修改。

启用小部件的配置示例（具体小部件名称需参考镜像内置清单）：

json
{
  "widgets": [
    "standard-widget-1", 
    "standard-widget-2",
    "extra-widget-1",  // 额外小部件1
    "extra-widget-2"   // 额外小部件2
  ],
  // 其他标准Enketo配置项...
}

注意：需将额外小部件名称添加到widgets数组中，未列出的小部件将不被加载。

其他核心配置

可参考https://github.com/enketo/enketo-express%E9%85%8D%E7%BD%AE%E5%85%B6%E4%BB%96%E5%8F%82%E6%95%B0%EF%BC%8C%E5%A6%82API%E7%AB%AF%E7%82%B9%E3%80%81%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5%E3%80%81%E7%BC%93%E5%AD%98%E7%AD%96%E7%95%A5%E7%AD%89%E3%80%82

验证配置

容器启动后，可通过访问http://localhost:8005验证服务状态，或检查日志确认额外小部件是否成功加载：

bash
docker logs enketo-extra-widgets | grep "extra widgets loaded"