wekan/docs/README.md

<img src="https://wekan.github.io/wekan-logo.svg" width="60%" alt="Wekan logo" />

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.

## Getting started
There are various ways to get started with Wekan:

* you can use the [Sandstorm app demo], 
* you could [[install|Install-and-Update]] it right away on your own server, or
* you could look through our [[contributing guidelines|Developer Documentation]]  to get involved in the project.

If you still have questions, check out the [[FAQ]]!

<a name="Wekan"></a>Wekan

# <a name="General"></a>General

* [Deep Dive Into WeKan](DeveloperDocs/Deep-Dive-Into-WeKan.md)
* [Meteor WeKan Roadmap](https://boards.wekan.team/b/D2SzJKZDS4Z48yeQH/wekan-open-source-kanban-board-with-mit-license) - board at Wekan demo
* [Multiverse WeKan Roadmap](FAQ/WeKan-Multiverse-Roadmap.md)
* OLD Docs/Manual: https://github.com/wekan/wekan/discussions/4522
* [Change Language](Translations/Change-Language.md)
* [Forgot Password](Login/Forgot-Password.md)
* [Test Edge](DeveloperDocs/Test-Edge.md)
* [WeKan Design Principles](DeveloperDocs/Design-Principles.md)
* [FAQ](FAQ/FAQ.md)
* [IRC FAQ](FAQ/IRC-FAQ.md) - answers to questions asked at IRC
* [Team](FAQ/Team.md)
* [Press](FAQ/Press.md)
* [Blog](https://blog.wekan.team)
* [Wekan vs Trello vs Restyaboard](ImportExport/trello/Wekan-vs-Trello-vs-Restyaboard.md)
* [Results of Survey 2020-01](https://blog.wekan.team/2020/06/results-of-wekan-survey-2020-01/)

# <a name="NotWeKan"></a>Fake: Not WeKan kanban

* [Hall of Shame: Fake companies that are NOT WeKan kanban](FAQ/Hall-of-Shame.md)
* [Others NOT related to WeKan kanban](FAQ/NOT-related-to-Wekan.md)

# <a name="Security"></a>Security

* [Allow private boards only: Disable Public Boards](Features/Allow-private-boards-only.md)
* [Security Disclosure and details of Security in Wekan](../SECURITY.md)
* [Security issues](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3ASecurity)
* [Password Hashing](Login/Password-Hashing.md)

# <a name="Scaling"></a>Scaling

* [Cron: Hourly restart WeKan, because of memory leaks](Webserver/Cron.md)
* [Maybe: Add more RAM to Node.js to prevent crash](https://github.com/wekan/wekan/issues/3585)
* [Clustering AWS etc](Platforms/Propietary/Cloud/AWS.md)
* [Scaling](Webserver/Scaling.md)
* [Kubernetes](https://github.com/wekan/wekan/tree/main/helm/wekan)
* [Redis Oplog](https://github.com/cult-of-coders/redis-oplog)
* [Meteor Scaling](https://galaxy-guide.meteor.com/scaling.html) at [Meteor Cloud](https://meteor.com/cloud)
* [Scaling at Meteor forums](https://forums.meteor.com/t/meteor-scaling-performance-best-practices/52886/16)

# <a name="Migrating"></a>Migrating

* [From Previous Export, paste big WeKan JSON](ImportExport/From-Previous-Export.md)
* [Progress: Import/Export/Sync](ImportExport/Sync.md)
* [From CSV/TSV](ImportExport/CSV.md)
* [From Trello](ImportExport/trello/Migrating-from-Trello.md)
* [From Jira](ImportExport/Jira.md)
* [From Asana](ImportExport/Asana.md)
* [From Zenkit](ImportExport/ZenKit.md)
* [From old Wekan manually](ImportExport/Migrating-from-old-Wekan-manually.md)

# <a name="Support"></a>Support priorities for new features and bugfixes

1) [Commercial Support](https://wekan.team/commercial-support/)
2) [Community Support](https://github.com/wekan/wekan/issues)
3) [Debugging](DeveloperDocs/Debugging.md)

# Backup

* [Backup and Restore](Backup/Backup.md)

# <a name="Repair"></a>Repair

* [Repair MongoDB](Backup/Repair-MongoDB.md)
* [Using Meteor MongoDB to repair files](Platforms/FOSS/Sandstorm/Export-from-Wekan-Sandstorm-grain-.zip-file.md)
* [If board does not open and keeps loading](Features/If-board-does-not-open-and-keeps-loading.md)
* [Repair Docker](Platforms/FOSS/Docker/Repair-Docker.md)

# <a name="Themes"></a> Themes

* [Themes](Theme/Custom-CSS-themes.md)
* [Dark Mode](Theme/Dark-Mode.md)
* [Converting Meteor Stylus to CSS](Theme/Converting-Meteor-Stylus-to-CSS.md)

# <a name="MarkdownSyntax"></a>Markdown Syntax

* [Wekan Markdown](Wekan-Markdown)
* [Emoji](Emoji)
* [Mermaid Diagram](Mermaid-Diagram) DOES NOT WORK ANYMORE
* [Numbered text](Numbered-text)

# <a name="LoginAuth"></a>Login Auth

* [Automatic login](autologin)
* [Disable Password Login](Disable-Password-Login)
* [Forgot Password](Forgot-Password)
* [Admin: Impersonate user](Impersonate-user)
* [Adding Users](Adding-users)
* [Active users Presence](https://github.com/wekan/wekan/issues/3734)
* [Accounts Lockout: Brute force login protection](Accounts-Lockout)
* [LDAP](LDAP)
* [LDAP AD Simple Auth](LDAP-AD-Simple-Auth)
* [Keycloak](Keycloak)
* [Google login](Google-login)
* [Azure](Azure)
* [OAuth2](OAuth2), Auth0, GitLab, RocketChat
* [Oracle OIM on premise using OAuth2](Oracle-OIM)
* [ADFS 4.0 using OAuth2 and OpenID](ADFS)
* [Azure AD B2C using OAuth2](B2C)
* [Nextcloud](Nextcloud)
* [CAS](CAS) Please test
* [SAML](SAML) Please test
* [Zitadel](Zitadel)

# <a name="Logs"></a>Metrics, Logs, Stats

* [Metrics](Metrics)
* [Logs](Logs)
* [Stats](Features#stats)

# <a name="Integrations"></a>Integrations

* [IFTTT](IFTTT)
* [n8n Wekan docs](https://docs.n8n.io/nodes/n8n-nodes-base.wekan/#example-usage) - [n8n GitHub](https://github.com/n8n-io/n8n)
* [Integrations](Integrations)
* [Gogs](https://github.com/wekan/wekan-gogs)

# <a name="Time"></a>Time

* [Time Tracking](Time-Tracking)
* [Gantt Chart](Gantt)
* [Due Date](Due-Date)
* [Day of week start](Day-of-week-start)
* [Calendar](Calendar)

# <a name="Features"></a>Features

* [Multiline](Multiline)
* [Linked Cards](Linked-Cards)
* [Drag Drop](https://github.com/wekan/wekan/wiki/Drag-Drop) on Mobile and Desktop
* [Rclone: Store attachments to cloud storage like S3, MinIO, etc](Rclone)
* [Python based features](Python)
* [Burndown and Velocity Chart](Burndown-and-Velocity-Chart)
* [Wait Spinners](Wait-Spinners)
* [Translations](Translations)
* [Default Language for All Users](https://github.com/wekan/wekan/issues/3927)
* [Roadmap](Roadmap)
* [Features](Features)
* [Planning Poker](Planning-Poker)
* [Scaling](Scaling)
* [Custom Logo](Custom-Logo)
* [Subtasks](Subtasks) <== Has fix
* [Templates](Templates)
* [Cover](Cover)
* [Archive and Delete](Archive-and-Delete)
* [Custom Fields](Custom-Fields)
* [Fix Export board menu not visible on some boards](https://github.com/wekan/wekan/issues/1060)
* [RAM usage](https://github.com/wekan/wekan/issues/1088#issuecomment-311843230)
* [Demo](https://wekan.indie.host/b/t2YaGmyXgNkppcFBq/wekan-fork-roadmap)
* [Swimlane Documentation](Swimlanes)
* [Customize Translations](Customize-Translations)

# <a name="Email"></a>Email

* [Email](Troubleshooting-Mail)

# <a name="Settings"></a>Required Settings

* [Requirements](Requirements)
* [Ports, hostsfile, how Internet works](https://github.com/wekan/wekan/issues/2896)
* [ROOT_URL Settings](Settings)

# <a name="Platforms"></a>Download

* [Download Wekan for various Platforms](Platforms): Supported by xet7, Operating Systems, NAS, Cloud
* [Helm Chart for Kubernetes](Helm)

# <a name="Webservers"></a>Webservers

* [Caddy](Caddy-Webserver-Config)
* [Nginx](Nginx-Webserver-Config)
* [Apache](Apache)
* [OpenLiteSpeed](https://github.com/wekan/wekan/issues/3334#issuecomment-723651328)
* [Local self signed TLS](Local-self-signed-TLS)
* [Let's Encrypt and Google Auth](Let's-Encrypt-and-Google-Auth)
* [TLS with Node.js](https://github.com/wekan/wekan/issues/916)
* [Traefik and self-signed SSL certs](Traefik-and-self-signed-SSL-certs)

# <a name="API"></a>REST API Docs

* [REST API Code](REST-API-Code)
* [Login](REST-API)
* [User](REST-API-User)
* [Role](REST-API-Role)
* [Boards](REST-API-Boards)
* [Lists](REST-API-Lists)
* [Cards](REST-API-Cards)
* [Checklists](REST-API-Checklists)
* [Swimlanes](REST-API-Swimlanes)
* [Custom Fields](REST-API-Custom-Fields)
* [Integrations](REST-API-Integrations)

# <a name="api-issue"></a>REST API issue

* [REST API Issue](https://github.com/wekan/wekan/issues/1037)

# <a name="api-client-code"></a>REST API client code

* [Example: New card with Python3 and REST API](New-card-with-Python3-and-REST-API)
* [Python client to REST API](https://github.com/wekan/wekan-python-api-client)
* [Go client to REST API](https://github.com/wekan/wego)
* [Java](Java)
* [Wekan Sandstorm cards to CSV using Python](Wekan-Sandstorm-cards-to-CSV-using-Python)
* [Excel and VBA](Excel-and-VBA)

# <a name="Webhooks"></a>Webhooks

* [Global Webhook](https://github.com/wekan/wekan/pull/2665)
* [Limiting Webhook data](https://github.com/wekan/wekan/issues/2830)
* [Receiving Webhooks](Receiving-Webhooks)
* [Outgoing Webhook to Discord/Slack/RocketChat/Riot](Outgoing-Webhook-to-Discord)
* [Outgoing Webhook to NodeRed](https://github.com/wekan/wekan/issues/2017)
* [Outgoing Webhook to PowerShell](https://github.com/wekan/wekan/issues/2518)
* [Security: Webhook and CA](WebHook-And-CA)
* [Outgoing Webhooks Data](Webhook-data)
* [Outgoing Webhooks and Let's Encrypt](WebHook-And-CA)
* Outgoing Webhooks [Original Pull Request](https://github.com/wekan/wekan/pull/1119), [multiple Webhooks](https://github.com/wekan/wekan/pull/1199), [more parameters and response order](https://github.com/wekan/wekan/pull/1263)

# <a name="Case-Studies"></a>Case Studies

* [Implementing GDPR](GDPR)

# <a name="Development"></a>Development

* [Kadira integration](https://github.com/wekan/wekan/issues/2152)
* [Debugging](Debugging)
* [Developer Docs for Standalone Wekan](Developer-Documentation)
* [Developer Docs for Sandstorm Wekan](https://github.com/wekan/wekan-maintainer/wiki/Developing-Wekan-for-Sandstorm)
* [Adding new Snap setting to code](Adding-new-Snap-settings-to-code)
* [Directory Structure](Directory-Structure)
* [Building Wekan for Sandstorm](https://github.com/wekan/wekan-maintainer/wiki/Building-Wekan-for-Sandstorm)
* [Docs - Sandstorm etc](https://github.com/wekan/wekan/labels/Documentation)
* [Beginner](https://github.com/wekan/wekan/labels/Beginner)
* [Maintainer FAQ](https://github.com/wekan/wekan-maintainer/wiki/FAQ)

# <a name="Issues"></a>Issues

* [Bugs](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3ABug)
* [Feature requests](https://github.com/wekan/wekan/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20feature)
* [Import / Export](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3AImport-export)
* [Drag and Drop](https://github.com/wekan/wekan/labels/Feature%3ADrag-and-drop)
* [Accessibility](https://github.com/wekan/wekan/labels/Accessibility)
* [Navigation:Keyboard](https://github.com/wekan/wekan/labels/Navigation%3AKeyboard)
* [Targets:Mobile-web](https://github.com/wekan/wekan/labels/Targets%3AMobile-web)
* [REST API](https://github.com/wekan/wekan/labels/API%3AREST)
* [Admin Panel](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3AAdmin-Panel)
* [Encryption](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3AEncryption)
* [Permissions](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3AUser-accounts%3APermissions)
* [Logs](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3ALogs)
* [Notifications](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3ANotifications)
* [Filters](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3AFilters)
* [Checklists](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3ACards%3AChecklists)
* [Swimlanes](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3ACards%3ASwimlanes)
* [LibreJS](https://github.com/wekan/wekan/issues/1040)
* [Markdown](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+label%3AFeature%3AMarkdown)

[kanban board]: https://en.wikipedia.org/wiki/Kanban_board
[mit license]: https://github.com/wekan/wekan/blob/main/LICENSE
[sandstorm app demo]: https://demo.sandstorm.io/appdemo/m86q05rdvj14yvn78ghaxynqz7u2svw6rnttptxx49g1785cdv1h#