Table of Contents
- Current
- Kanban
- WIP Limits
- Boards: List of all your public and private boards, board shortcuts at top of page
- Wekan full screen or window on desktop (without browser buttons etc)
- Wekan full screen on mobile Firefox
- Restore archived board
- Star board
- Watch board
- Keyboard shortcuts button at bottom right corner
- Board menu when clicking 3 lines "hamburger" menu on right
- Member setting when clicking your username on top right corner
- Member settings / Edit Notification
- Member settings / Change settings
- Members: Click member initials or avatar
- Members: Click member initials or avatar => Permissions Admin/Normal/Comment only
- Lists: Add, archive and restore archived, delete list.
- Cards: Description, Customizable Labels, Checklists, Attachment images and files, Comments. Archive and restore archived card. Delete card.
- Markdown in card description and comments
- International Date Formatting for Due Date according to language
- Cards: Drag and drop images to card. Paste images with Ctrl-V.
- 1) First attachment: Select Card 3 lines "hamburger" menu / Edit Attachments
- 2) Select: Clipboard or drag and drop
- 3) Drag and drop image, or Ctrl-V.
- 4) Second image attachment and others can be added from Add Attachment button near first attachment.
- Multi-selection => Checkmark select cards => drag-drop all selected to some list
- Filtered views
- Authentication, Admin Panel, SMTP Settings
- Import
- Export
- Working with big boards
- API
- Webhooks
- Cleanup
- Stats
- Versions of Meteor and Node
- Translations
- Already merged, will be at next version
- Wishes for pull requests
- More
Current
Not all from CHANGELOG are added to here yet.
Kanban
WIP Limits
Boards: List of all your public and private boards, board shortcuts at top of page
Wekan full screen or window on desktop (without browser buttons etc)
Info about browser standalone app mode
Wekan full screen on mobile Firefox
Restore archived board
Star board
Watch board
Keyboard shortcuts button at bottom right corner
Board menu when clicking 3 lines "hamburger" menu on right
Member setting when clicking your username on top right corner
NOTE: Edit Notification duplicate was removed from above menu at https://github.com/wekan/wekan/pull/1948 so Edit Notification is only available at below menu screenshot.
Member settings / Edit Notification
Member settings / Change settings
Members: Click member initials or avatar
Members: Click member initials or avatar => Permissions Admin/Normal/Comment only
Lists: Add, archive and restore archived, delete list.
Cards: Description, Customizable Labels, Checklists, Attachment images and files, Comments. Archive and restore archived card. Delete card.
Tip: Normally you archive a card so you can restore it back. If you want to delete cards faster, drag cards to new list, and delete that new list. Deleting cannot be undone, more clicks are by design. There was previously easily clicked button to delete a list and people deleted important list by accident, and that bug report was fixed.
Markdown in card description and comments
International Date Formatting for Due Date according to language
Cards: Drag and drop images to card. Paste images with Ctrl-V.
1) First attachment: Select Card 3 lines "hamburger" menu / Edit Attachments
2) Select: Clipboard or drag and drop
3) Drag and drop image, or Ctrl-V.
4) Second image attachment and others can be added from Add Attachment button near first attachment.
Multi-selection => Checkmark select cards => drag-drop all selected to some list
Filtered views
Authentication, Admin Panel, SMTP Settings
NOTE: There is user admin as "People" in Admin Panel, but no screenshot here yet.
- Source and Docker platforms: Admin Panel: Self-registration, or change to invite-only and inviting users to boards. SMTP Settings.
- Sandstorm Platform: Admin: LDAP, passwordless email, SAML, GitHub and Google Auth. Add and remove users. SMTP Settings. Wekan, Rocket.Chat, etc apps available with one click install.
Import
- Import Trello board: Text, labels, images, comments, checklists. Not imported yet: stickers, etc.
- Import Wekan board: Text, labels, images, comments, checklists.
Export
- Export Wekan board: Export menu item above the board archive item, when you click the sandwich bar icon on the top right. If Export menu is not visible, you can change Export menu to be visible by setting yourself as board admin in MongoDB.
Working with big boards
API
Webhooks
Sending notifications for board activities. Tested with Slack and Rocket.chat.
Content-type: application/json
{
"text": "board activities"
[...]
}
Different activities send different webhook data. You can find the details in the wiki page Webhook data
Enabled
1) Board menu when clicking 3 lines "hamburger" menu on right
2) Outgoing Webhooks
Disabled
Leave the URL field blank.
Cleanup
Stats
- Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
- Statistics Python script for Wekan Dashboard
- Console, file, and zulip logger on database changes with fix to replace console.log by winston logger
Versions of Meteor and Node
- Upgraded to Meteor 1.4 and Node v4 on meteor-1.4 branch
Translations
Already merged, will be at next version
Wishes for pull requests
Existing pull requests, cleanup/cherry-picking/new pull requests welcome
- Export/Import Excel TSV/CSV data
- Move/Clone Board/List and Move or copy cards from one board to another that needs help in implementation
- Replace CollectionFS with meteor-file-collection
Wishes for API pull requests
Wishes for Admin Panel
- SMTP test, show possible errors on that test webpage
- Teams/Organizations including Add/Modify/Remove Teams/Users/Passwords and Private/Public Team settings
- Themes and making custom apps with Themes
Wishes for Boards
- Custom fields
- Children/Related cards, subtasks. Dependencies.
- Top Level Projects
- Swimlanes (rows)
- Kanban workflows
- Gantt charts
- WIP limits
- Timesheet/Time tracking
- Managing website
- Same cards, multiple column sets, related to Themes
- Calendar view
- Vote on cards, number of votes, average
- Board templates
- Checklist templates
More
Wekan
General
- Deep Dive Into WeKan
- Meteor WeKan Roadmap - board at Wekan demo
- Multiverse WeKan Roadmap
- Docs/Manual
- Change Language
- Forgot Password
- About
- Test Edge
- 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
Security
- Allow private boards only: Disable Public Boards
- Security Disclosure and details of Security in Wekan
- Security issues
- 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
- Redis Oplog
- Meteor Scaling at Meteor Cloud
- 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
- Converting Meteor Stylus to CSS
Support priorities for new features and bugfixes
Backup
Repair
- Repair MongoDB
- Using Meteor MongoDB to repair files
- If board does not open and keeps loading
- Repair Docker
Themes
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
Integrations
Time
Features
- Multiline
- Linked Cards
- Drag Drop on Mobile and Desktop
- Rclone: Store attachments to cloud storage like S3, MinIO, etc
- Python based features
- Burndown and Velocity Chart
- Wait Spinners
- Translations
- Default Language for All Users
- Roadmap
- Features
- Planning Poker
- Scaling
- Custom Logo
- Subtasks <== Has fix
- Templates
- Cover
- Archive and Delete
- Custom Fields
- Fix Export board menu not visible on some boards
- RAM usage
- Demo
- Swimlane Documentation
- Customize Translations
Required Settings
Download
- Download Wekan for various Platforms: Supported by xet7, Operating Systems, NAS, Cloud
- Helm Chart for Kubernetes
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
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
- Java
- Wekan Sandstorm cards to CSV using Python
- Excel and VBA
Webhooks
- Global Webhook
- Limiting Webhook data
- Receiving Webhooks
- Outgoing Webhook to Discord/Slack/RocketChat/Riot
- Outgoing Webhook to NodeRed
- Outgoing Webhook to PowerShell
- Security: Webhook and CA
- Outgoing Webhooks Data
- Outgoing Webhooks and Let's Encrypt
- Outgoing Webhooks Original Pull Request, multiple Webhooks, more parameters and response order
Case Studies
Development
- Kadira integration
- Debugging
- Developer Docs for Standalone Wekan
- Developer Docs for Sandstorm Wekan
- Adding new Snap setting to code
- Directory Structure
- Building Wekan for Sandstorm
- Docs - Sandstorm etc
- Beginner
- Maintainer FAQ
Issues
Wekan - OpenSource Kanban