WeKan 看板工具搭建教程
WeKan 是一款开源的看板协作工具,被视为 Trello 的自托管替代方案。它提供直观的拖拽式看板界面、丰富的卡片功能和灵活的权限管理,适合个人任务管理和团队项目协作。WeKan 轻量高效,资源占用小,非常适合在搬瓦工 VPS 上部署使用。
一、WeKan 核心功能
- 看板管理:创建多个看板,每个看板包含自定义列表和卡片,支持拖拽排序。
- 卡片功能:支持描述、检查清单、标签、截止日期、附件、评论和负责人分配。
- 泳道:支持横向泳道分组,方便按类别或团队组织卡片。
- 看板模板:可以将看板保存为模板,快速创建同类项目。
- API 支持:完整的 REST API,支持与外部系统集成和自动化。
- 多语言:支持超过 50 种语言,包括简体中文。
二、环境准备
- 操作系统:Ubuntu 20.04+(推荐 Ubuntu 22.04)。
- 内存:至少 512MB RAM,推荐 1GB。
- 磁盘:至少 5GB 可用空间。
- Docker:已安装 Docker 和 Docker Compose(参考 Docker 安装教程)。
购买搬瓦工 VPS 请参考 全部方案,优惠码 NODESEEK2026 可享受 6.77% 折扣。
三、Docker Compose 部署
3.1 创建项目目录
mkdir -p /opt/wekan && cd /opt/wekan
3.2 创建 Docker Compose 文件
cat > docker-compose.yml <<'EOF'
version: '3.8'
services:
wekan:
image: quay.io/wekan/wekan:latest
container_name: wekan
restart: always
ports:
- "8080:8080"
environment:
WRITABLE_PATH: /data
MONGO_URL: "mongodb://mongo:27017/wekan"
ROOT_URL: "http://your-domain.com"
MAIL_URL: ""
MAIL_FROM: "WeKan "
WITH_API: "true"
RICHER_CARD_COMMENT_EDITOR: "true"
BROWSER_POLICY_ENABLED: "true"
volumes:
- wekan_data:/data
depends_on:
- mongo
mongo:
image: mongo:6.0
container_name: wekan-mongo
restart: always
command: mongod --oplogSize 128
volumes:
- mongo_data:/data/db
- mongo_dump:/dump
volumes:
wekan_data:
mongo_data:
mongo_dump:
EOF
3.3 启动 WeKan
docker compose up -d
docker compose logs -f wekan
启动完成后,访问 http://你的服务器IP:8080 注册第一个用户账户。第一个注册的用户自动成为管理员。
四、Nginx 反向代理
apt update && apt install nginx -y
cat > /etc/nginx/sites-available/wekan <<'EOF'
server {
listen 80;
server_name kanban.example.com;
client_max_body_size 50m;
location / {
proxy_pass http://127.0.0.1:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
}
EOF
ln -s /etc/nginx/sites-available/wekan /etc/nginx/sites-enabled/
nginx -t && systemctl reload nginx
apt install certbot python3-certbot-nginx -y
certbot --nginx -d kanban.example.com
配置完成后更新 Compose 文件中的 ROOT_URL 为 HTTPS 地址并重启。
五、WeKan 使用指南
5.1 创建看板
登录后点击"Add Board"创建新看板。为看板设置标题、背景色和权限级别(公开或私有)。在看板中添加列表(如"待办"、"进行中"、"已完成"),然后在列表中添加卡片。卡片可以通过拖拽在列表之间移动。
5.2 卡片详情
点击卡片打开详情面板,可以添加:详细描述(支持 Markdown)、检查清单(待办事项列表)、截止日期和提醒、标签(自定义颜色和名称)、成员分配、文件附件和评论讨论。卡片还支持设置自定义字段,扩展卡片的信息维度。
5.3 泳道与过滤
泳道(Swimlane)在看板中添加横向分隔,适合按团队、模块或优先级分组展示卡片。过滤功能支持按成员、标签、截止日期等条件筛选卡片,快速找到关注的任务。
5.4 管理员设置
以管理员身份登录后,在管理面板可以:管理用户账户和角色、配置注册方式(开放注册或邀请制)、设置全局看板权限、配置邮件服务器和查看系统信息。
六、数据备份
# 备份 MongoDB 数据
docker exec wekan-mongo mongodump --db wekan --out /dump/backup_$(date +%Y%m%d)
docker cp wekan-mongo:/dump /opt/wekan/mongo_backup_$(date +%Y%m%d)
# 恢复数据
docker cp mongo_backup wekan-mongo:/dump/restore
docker exec wekan-mongo mongorestore --db wekan /dump/restore/wekan
# 定时备份
crontab -e
0 2 * * * docker exec wekan-mongo mongodump --db wekan --out /dump/daily_$(date +\%Y\%m\%d)
七、升级 WeKan
cd /opt/wekan
docker compose pull
docker compose down
docker compose up -d
总结
WeKan 是一款轻量但功能完善的看板工具,部署简单、资源占用低,非常适合在搬瓦工 VPS 上运行。如果你需要更多项目管理功能,可以参考 Plane 或 Taiga;类似的看板工具还有 Focalboard。购买搬瓦工 VPS 请参考 全部方案,使用优惠码 NODESEEK2026 可享受折扣。