christiancarle/wekan

Wekan 镜像文档

镜像概述和主要用途

Wekan 是一款完全开源（Open Source）和自由软件（Free Software）的协作看板应用，采用 MIT 许可证。它提供直观的看板界面，帮助用户可视化管理任务状态，无论是个人待办事项、团队项目规划还是创意协作，都能有效提升工作效率。用户可将其部署在个人计算机或服务器上，确保数据隐私与安全。

核心功能和特性

• 开源免费：基于 MIT 许可证，完全开源，可自由使用、修改和分发。
• 实时用户界面：支持多人实时协作，任务状态变更即时同步。
• 多平台支持：可在多种操作系统和平台上部署（具体支持平台见 https://github.com/wekan/wekan/wiki/Platforms%EF%BC%89%E3%80%82
• 自托管能力：支持本地部署，无需依赖第三方服务，保障数据控制权。
• 丰富集成：可与多种工具集成（详见 https://github.com/wekan/wekan/wiki/Integrations%EF%BC%89%E3%80%82
• 可视化任务管理：通过看板、列表、卡片等元素直观展示任务状态，支持拖拽操作。

使用场景和适用范围

• 个人任务管理：维护个人待办清单，规划日常活动。
• 团队协作：团队项目进度跟踪，任务分配与状态管理。
• 项目规划：可视化项目流程，监控各阶段任务完成情况。
• 活动组织：如假期计划、活动筹备等多人协作场景。

使用方法和配置说明

前提条件

• 安装 Docker 和 Docker Compose（推荐）
• 确保 MongoDB 服务可用（Wekan 依赖 MongoDB 存储数据）

Docker 快速部署

使用 docker run 命令快速启动 Wekan（需先启动 MongoDB）：

bash
# 启动 MongoDB
docker run -d --name wekan-mongo -v wekan-data:/data/db mongo:4.4

# 启动 Wekan，连接到 MongoDB
docker run -d --name wekan --link wekan-mongo:mongo -p 8080:8080 \
  -e MONGO_URL=mongodb://mongo:27017/wekan \
  -e ROOT_URL=http://localhost:8080 \
  wekanteam/wekan

Docker Compose 配置

创建 docker-compose.yml 文件，包含 Wekan 和 MongoDB 服务：

yaml
version: '3'
services:
  wekan:
    image: wekanteam/wekan
    ports:
      - "8080:8080"
    environment:
      - MONGO_URL=mongodb://mongo:27017/wekan
      - ROOT_URL=http://localhost:8080
      - PORT=8080
    depends_on:
      - mongo
    restart: always

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

volumes:
  wekan-data:

启动服务：

bash
docker-compose up -d

环境变量配置

常用环境变量说明：

• MONGO_URL：MongoDB 连接 URL（必填，格式如 mongodb://mongo:27017/wekan）
• ROOT_URL：Wekan 访问 URL（如 http://yourdomain.com 或 http://localhost:8080）
• PORT：Wekan 服务端口（默认 8080）
• MAIL_URL：邮件服务配置（用于发送通知，格式如 smtp://user:pass@smtp.example.com:587）
• ADMIN_USERNAME 和 ADMIN_PASSWORD：初始管理员账户（可选，用于创建管理员用户）

更多配置参数详见 https://github.com/wekan/wekan/wiki/Settings%E3%80%82

相关资源

• https://github.com/wekan/wekan
• https://github.com/wekan/wekan/wiki/Features
• https://github.com/wekan/wekan/wiki/Integrations
• https://github.com/wekan/wekan/wiki/Developer-Documentation
• 演示地址