onaio/kpi

KPI Formbuilder Docker镜像文档

镜像概述

KPI Formbuilder Docker镜像是一个预配置的容器化解决方案，用于快速部署和运行KPI（关键绩效指标）表单构建工具。该镜像封装了表单设计、数据收集、分析与管理的核心功能，提供便捷的部署方式，适用于各类需要跟踪和评估绩效目标的场景。

核心功能与特性

主要功能

• 可视化表单设计器：通过拖拽式界面快速创建自定义KPI表单，无需编写代码
• 多样化字段类型：支持数值、百分比、日期、下拉选择、文本等多种KPI指标字段
• 数据管理与分析：内置数据表格视图，支持筛选、排序和基础数据分析
• 数据导出：支持将收集的KPI数据导出为CSV、Excel格式，便于进一步分析
• 权限控制：支持多用户角色管理，控制表单的查看、编辑和管理权限

特性优势

• 轻量级部署：基于Docker容器化，简化环境配置，快速启动
• 响应式设计：适配桌面和移动设备，支持随时随地访问和填写表单
• 数据持久化：支持外部数据卷挂载，确保表单配置和收集数据不会丢失
• 可扩展架构：支持通过API与其他系统集成（如CRM、HRM系统）

使用场景与适用范围

典型使用场景

• 企业绩效评估：HR部门用于收集各部门KPI数据，支持季度/年度绩效评估
• 团队目标跟踪：项目团队用于设定和跟踪阶段性KPI目标，实时监控进度
• 项目管理：项目经理用于收集项目关键指标（如完成率、成本控制等）数据
• 销售业绩管理：销售团队用于记录和分析销售额、客户转化率等业绩指标

适用范围

• 中小型企业的绩效管理制度建设
• 大型企业各部门的KPI数据收集与汇总
• 初创团队的目标设定与进度跟踪
• 教育机构的教学质量评估指标管理

使用方法与配置说明

快速启动（docker run）

bash
docker run -d \
  --name kpi-formbuilder \
  -p 8080:8080 \
  -v /path/to/local/data:/app/data \
  -e ADMIN_USER=admin \
  -e ADMIN_PASSWORD=securepassword \
  kpi-formbuilder:latest

参数说明：

• -p 8080:8080：端口映射，将容器内8080端口映射到主机8080端口
• -v /path/to/local/data:/app/data：数据卷挂载，持久化保存表单配置和数据
• -e ADMIN_USER：管理员用户名（默认：admin）
• -e ADMIN_PASSWORD：管理员密码（建议使用强密码）

Docker Compose配置示例

yaml
version: '3'
services:
  kpi-formbuilder:
    image: kpi-formbuilder:latest
    container_name: kpi-formbuilder
    ports:
      - "8080:8080"
    volumes:
      - ./data:/app/data
    environment:
      - ADMIN_USER=admin
      - ADMIN_PASSWORD=your_secure_password
      - DB_TYPE=sqlite  # 支持sqlite/mysql/postgresql，默认sqlite
      - DB_HOST=db      # 若使用外部数据库，指定数据库主机
      - DB_PORT=3306    # 数据库端口
      - DB_USER=formuser
      - DB_PASSWORD=dbpassword
      - DB_NAME=kpiforms
    restart: unless-stopped

环境变量配置

访问与使用

1. 启动容器后，通过浏览器访问 http://<主机IP>:8080
2. 使用配置的管理员账户（ADMIN_USER/ADMIN_PASSWORD）登录
3. 在控制台中点击"新建表单"，使用拖拽式设计器创建KPI表单
4. 配置表单字段（如KPI名称、目标值、实际值、权重等）
5. 发布表单后，通过分享链接或嵌入代码收集数据
6. 在"数据管理"页面查看、导出和分析收集的KPI数据

数据持久化

为确保表单配置和收集的数据不丢失，建议通过数据卷挂载 /app/data 目录（sqlite数据库默认存储路径）。若使用外部数据库（如MySQL），需确保数据库服务独立部署并配置持久化。

注意事项

• 首次启动时，系统会自动初始化数据库结构，可能需要30秒左右
• 生产环境中建议修改默认管理员密码，并使用外部数据库提高数据安全性
• 表单数据量较大时，建议定期备份挂载的数据卷或数据库
• 支持通过环境变量 LOG_LEVEL 调整日志级别（debug/info/warn/error，默认info）