wekan/docs

Wekan is an open-source kanban board which allows a card-based task and to-do management.

Wekan allows to create Boards, on which Cards can be moved around between a number of Columns. Boards can have many members, allowing for easy collaboration, just add everyone that should be able to work with you on the board to it, and you are good to go! You can assign colored Labels to cards to facilitate grouping and filtering, additionally you can add members to a card, for example to assign a task to someone.

What is special about Wekan?

Wekan is distributed under the MIT License, allowing anyone to easily work with it and modify it. It is perfect for anyone that needs a slick kanban board but doesn't want to use third party services, which are out of user control. Wekan can be hosted on your own server with very little effort, guaranteeing that you have all the time full control over your data and can make sure no one else has access to it and that it won't just vanish from one day to another, that is, if you do backups.

Wekan

Install

• https://wekan.fi/install/

SaaS

• https://wekan.fi/saas/

Support

• Free Public Open Source Support, bugs and feature requests: https://github.com/wekan/wekan/issues
  • Debugging
• Paid Private Commercial Support, paid features/fixes/support/hosting: https://wekan.fi/commercial-support/

General

• Current Meteor 2 WeKan Features: Deep Dive Into WeKan
• WeKan Roadmap kanban board - board at Wekan demo
• Future WeKan prototypes: Multiverse WeKan Roadmap
• Change Language
• Forgot Password
• WeKan Design Principles
• FAQ
• IRC FAQ - answers to questions asked at IRC
• Team
• Press
• Blog
• Wekan vs Trello vs Restyaboard
• Results of Survey 2020-01

Fake: Not WeKan kanban

• Hall of Shame: Fake companies that are NOT WeKan kanban
• Others NOT related to WeKan kanban

Security

• Allow private boards only: Disable Public Boards
• Security Disclosure and details of Security in Wekan
• Password Hashing

Scaling

• Cron: Hourly restart WeKan, because of memory leaks
• Maybe: Add more RAM to Node.js to prevent crash
• Clustering AWS etc
• Scaling
• Kubernetes
  • Helm Chart https://artifacthub.io/packages/helm/wekan/wekan
  • Issues https://github.com/wekan/charts/issues
  • Pull Requests https://github.com/wekan/charts/pulls
• Redis Oplog
• Scaling at Meteor forums

Migrating

• From Previous Export, paste big WeKan JSON
• Progress: Import/Export/Sync
• From CSV/TSV
• From Trello
• From Jira
• From Asana
• From Zenkit
• From old Wekan manually

Backup

• Backup and Restore
• Rclone: Store attachments to cloud storage like S3, MinIO, etc

Repair

• Repair MongoDB
• Using Meteor MongoDB to repair files
• If board does not open and keeps loading
• Repair Docker

Themes

• Themes
• Dark Mode
• Converting Meteor Stylus to CSS

Markdown Syntax

• Wekan Markdown
• Emoji
• Mermaid Diagram DOES NOT WORK ANYMORE
• Numbered text

Login Auth

• Automatic login
• Disable Password Login
• Forgot Password
• Admin: Impersonate user
• Adding Users
• Active users Presence
• Accounts Lockout: Brute force login protection
• LDAP
• LDAP AD Simple Auth
• Keycloak
• Google login
• Azure
• OAuth2, Auth0, GitLab, RocketChat
• Oracle OIM on premise using OAuth2
• ADFS 4.0 using OAuth2 and OpenID
• Azure AD B2C using OAuth2
• Nextcloud
• CAS Please test
• SAML Please test
• Zitadel

Metrics, Logs, Stats

• Metrics
• Logs
• Stats

Integrations

• IFTTT
• n8n Wekan docs - n8n GitHub
• Integrations
• Gogs

Time

• Time Tracking
• Gantt Chart
• Due Date
• Day of week start
• Calendar

Features

• Multiline
• Linked Cards
• Drag Drop on Mobile and Desktop
• Python based features
• Burndown and Velocity Chart
• Wait Spinners
• Translations
• Customize Translations
• Default Language for All Users
• Features
• Planning Poker
• Scaling
• Custom Logo
• Subtasks
• Templates
• Card Cover Image
• Archive and Delete
• Custom Fields
• Fix Export board menu not visible on some boards
• RAM usage
• Swimlanes

Email

• Email

Required Settings

• Requirements
• Ports, hostsfile, how Internet works
• ROOT_URL Settings

Webservers

• Caddy
• Nginx
• Apache
• OpenLiteSpeed
• Local self signed TLS
• Let's Encrypt and Google Auth
• TLS with Node.js
• Traefik and self-signed SSL certs

REST API Docs

• API docs https://wekan.fi/docs/
• PHP Webhook receiver to WeKan API Python https://github.com/wekan/webhook/blob/main/public/index.php#L46
• API clients
  • Python
  • https://github.com/wekan/wekan/blob/main/api.py
  • https://github.com/wekan/wekan-python-api-client
  • https://github.com/wekan/python-wekan
  • Other Python features https://github.com/wekan/wekan/blob/main/docs/Features/Python.md
  • Go https://github.com/wekan/wego
• Other API
• REST API Code
• Login
• User
• Role
• Boards
• Lists
• Cards
• Checklists
• Swimlanes
• Custom Fields
• Integrations

REST API issue

• REST API Issue

REST API client code

• Example: New card with Python3 and REST API
• Python client to REST API
• Go client to REST API
• Wekan Sandstorm cards to CSV using Python
• Excel and VBA

Webhooks

• Per-board events sending at board right sidebar / Board Settings / Webhooks
  • Check that webhook immediately responds with HTTP 200 OK, otherwise WeKan slows down
• Global Webhook
• PHP Webhook receiver to WeKan API Python https://github.com/wekan/webhook/blob/main/public/index.php#L46
• Limiting Webhook data
• Receiving Webhooks
• Java Webhooks
• Outgoing Webhook to Discord/Slack/RocketChat/Riot
• Outgoing Webhook to NodeRed
• Outgoing Webhook to PowerShell
• Outgoing Webhooks, CA and Let's Encrypt
• Outgoing Webhooks Data
• Outgoing Webhooks Original Pull Request, multiple Webhooks, more parameters and response order

Development

• Kadira integration
• Debugging
• Developer Docs for Standalone Wekan
• Developer Docs for Sandstorm Wekan
• Adding new Snap setting to code
• Directory Structure
• Beginner
• Maintainer FAQ

Issues

• Bugs
• Feature requests
• Import / Export
• Drag and Drop
• Accessibility
• Navigation:Keyboard
• Targets:Mobile-web
• REST API
• Admin Panel
• Encryption
• Permissions
• Logs
• Notifications
• Filters
• Checklists
• Swimlanes
• LibreJS
• Markdown