wekanteam/wekan

WeKan ® - 开源看板应用

镜像概述

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

核心功能与特性

• 开源免费：采用MIT许可证，完全开源可自由使用、修改和分发。
• 实时协作：具备实时用户界面，支持多人同时编辑看板。
• 多语言支持：已通过Transifex平台翻译成约105种语言。
• 多平台兼容：支持Linux（Snap/Sandstorm）、macOS、Windows等64位系统，以及树莓派3 ARM等支持Node.js和MongoDB的架构。
• 广泛应用：全球多数国家使用，最大企业用户规模达30,000人，是多个新兴平台的关键组件。

使用场景

• 个人任务管理：创建待办事项列表，跟踪日常任务进度。
• 团队协作：团队成员共享看板，分配任务、更新状态，提升协作效率。
• 项目规划：可视化项目流程，监控任务状态，优化工作流。
• 活动组织：与朋友或团队共同规划假期、活动筹备等事务。

Docker镜像获取与部署

镜像仓库

WeKan提供以下官方Docker镜像仓库：

• GitHub Container Registry：https://github.com/wekan/wekan/pkgs/container/wekan
• Quay：[***]
• Docker Hub：https://hub.docker.com/r/wekanteam/wekan

Docker Compose配置

官方提供完整的docker-compose.yml配置文件，可从以下地址获取：
https://github.com/wekan/wekan/blob/main/docker-compose.yml

部署步骤：

1. 下载上述配置文件
2. 根据需求修改参数（如端口映射、环境变量、数据卷挂载等）
3. 执行docker-compose up -d启动服务

系统要求

• 架构与系统：64位操作系统（Linux/macOS/Windows等）；支持树莓派3 ARM及其他兼容Node.js和MongoDB的CPU架构。
• 内存：至少1GB空闲内存；生产服务器建议总内存≥4GB；大规模部署（数千用户）需配置多前端服务器（每台2CPU、2个wekan-app容器）和多CPU后端数据库服务器。
• 磁盘空间：需足够存储空间并配置低空间警报（磁盘满会导致MongoDB损坏）。
• 安全与更新：必须频繁更新至最新版本（旧版本存在安全隐患，仅最新版受支持）；Sandstorm部署版本通常不受独立版安全问题影响。
• 数据备份：至少每日备份数据库（因bug、误操作、硬件故障等可能导致数据丢失，目前无撤销功能）。

其他信息

代码标准与质量

• 公共代码标准：2023年11月评估显示，开箱即满足16项标准中的8项，部分可通过小幅修改达标。
• 质量监控：通过CII最佳实践、Code Climate、Open Hub、OSS Insight等平台持续监控代码质量。

翻译与贡献

• 非英语翻译需通过Transifex提交：[***]
• 新功能英文字符串可提交PR至wekan/imports/i18n/data/en.i18n.json（master分支）。

问题反馈与支持

• 功能请求和bug报告：https://github.com/wekan/wekan/issues
• 商业支持：[***]
• 开发者文档：https://github.com/wekan/wekan/wiki/Developer-Documentation

许可证

WeKan ® 采用MIT许可证发布，基于Meteor框架开发。