mquandalle/wekan

Wekan - 开源看板应用

镜像概述和主要用途

Wekan 是一款完全开源（Open Source）和免费软件（Free Software）的协作看板应用，采用 MIT 许可证。无论是维护个人待办事项、与朋友规划假期，还是团队协作开发创新项目，看板都是保持事务有序的理想工具。它提供项目当前状态的可视化概览，帮助用户专注于最重要的任务。作为免费软件，用户可将 Wekan 部署在自有计算机或服务器上，无需将数据托管给第三方，保护数据隐私。

核心功能和特性

• 开源免费：基于 MIT 许可证，完全开源且免费使用，允许自由修改和分发。
• 实时用户界面：支持实时协作，多用户可同时编辑看板内容。
• 多语言支持：已翻译成约 63 种语言，方便全球用户使用。
• 多平台兼容：支持 Linux（Snap/Sandstorm）、Mac、Windows 等多种平台，以及树莓派 3 ARM 等 CPU 架构（需 Node.js 和 MongoDB 支持）。
• 大规模用户支持：最大用户案例为 13k 公司用户同时使用。
• 频繁更新：每日多次添加新功能和修复，持续优化用户体验。

使用场景和适用范围

• 个人任务管理：维护待办事项、日程规划，提升个人 productivity。
• 团队协作：项目任务分配、进度跟踪，支持团队成员实时同步信息。
• 项目规划：可视化项目流程，清晰展示任务状态（如待办、进行中、已完成）。
• 组织活动：如活动策划、资源分配等场景的任务协调。

系统要求

• 硬件架构：64 位系统（Linux、Mac、Windows 等），支持树莓派 3 ARM 等架构（需 Node.js 和 MongoDB）。
• 内存：最低 1GB 空闲内存；生产环境建议总内存至少 4GB；大规模用户（如数千用户）需配置多服务器（例：3 个前端服务器，每个 2 CPU + 2 个 wekan-app 容器；1 个后端 wekan-db 服务器，多 CPU）。
• 存储：足够的磁盘空间，需设置低磁盘空间警报（磁盘空间不足会导致 MongoDB 数据库损坏）。
• 安全：需频繁更新至最新版本（旧版本可能存在 Node.js 等组件的安全漏洞），仅支持最新版本。
• 备份：每日至少备份一次数据库（数据可能因 bug、用户误操作、硬件故障等丢失，暂不支持撤销功能）。

使用方法和配置说明

Docker 部署注意事项

重要：使用 Docker 时，请勿使用 latest 标签，仅使用发布标签（如 v6.18），避免兼容性问题。

Docker Run 示例

bash
# 启动 MongoDB 容器
docker run -d --name wekan-db \
  -v /path/to/wekan-db:/data/db \
  mongo:4.4

# 启动 Wekan 容器，连接 MongoDB
docker run -d --name wekan \
  --link wekan-db:mongodb \
  -p 8080:8080 \
  -e MONGO_URL=mongodb://mongodb:27017/wekan \
  -e ROOT_URL=http://localhost:8080 \
  wekanteam/wekan:v6.18  # 使用具体发布标签

Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'

services:
  mongodb:
    image: mongo:4.4
    volumes:
      - ./wekan-db:/data/db
    restart: always

  wekan:
    image: wekanteam/wekan:v6.18  # 使用具体发布标签
    ports:
      - "8080:8080"
    environment:
      - MONGO_URL=mongodb://mongodb:27017/wekan
      - ROOT_URL=http://localhost:8080
    depends_on:
      - mongodb
    restart: always

启动服务：

bash
docker-compose up -d

环境变量说明

注意事项

• 安全更新：务必保持 Wekan 为最新版本，旧版本可能存在安全漏洞。
• 数据备份：每日备份数据库，防止数据丢失（无撤销功能，数据库损坏或误操作可能导致数据无法恢复）。
• 问题反馈：发现 bug 或需求请通过 https://github.com/wekan/wekan/issues 提交，便于开发者及时处理。
• 翻译支持：非英语语言翻译需通过 Transifex 提交，英文新功能字符串可通过 PR 提交至 wekan/i18n/en.i18n.json。