plankanban

plankanban/planka

Elegant open source project tracking. Self-hosted Kanban for teams — free Community edition, with PLANKA Pro for organisations.

View on GitHub Website / Demo Back to listing

12.6kstars 1.4kforks 100+contributors JavaScript

README.md

View on GitHub

![Logo](https://raw.githubusercontent.com/plankanban/planka/master/assets/logo.png)

# PLANKA

_Project mastering driven by fun_

![Version](https://img.shields.io/github/package-json/v/plankanban/planka?style=flat-square) [![Docker Pulls](https://img.shields.io/badge/docker_pulls-8M%2B-%23066da5?style=flat-square&color=red)](https://github.com/plankanban/planka/pkgs/container/planka) [![Contributors](https://img.shields.io/github/contributors/plankanban/planka?style=flat-square&color=blue)](https://github.com/plankanban/planka/graphs/contributors) [![Chat](https://img.shields.io/discord/1041440072953765979?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/WqqYNd7Jvt)

[Install](https://docs.planka.cloud/docs/installation/docker/production-version/) ·  [Demo](https://planka.app) · [Docs](https://docs.planka.cloud/docs/welcome/) · [API](https://plankanban.github.io/planka/swagger-ui/) · [Cloud](https://planka.app/pricing) · [Pro version](https://planka.app/pro?ref=github-readme)

![Demo](https://raw.githubusercontent.com/plankanban/planka/master/assets/demo.gif)

</div>

---

## PLANKA Pro

**When the whole team runs on PLANKA.**

Phones and tablets · five themes · a dashboard across every project · calendar, timeline and
  map views · cards on more than one board · templates · guest roles · SSO · PDF export.
  Self-hosted exactly as you host it now, supported by the people who build it.

[![Try Pro free for 30 days](https://img.shields.io/badge/Try_Pro_free_for_30_days-22252a?style=for-the-badge)](https://planka.app/trial?ref=github-readme-trial)
  [![Features and pricing](https://img.shields.io/badge/Features_and_pricing-5a6c78?style=for-the-badge)](https://planka.app/pro?ref=github-readme-pro)

</div>

| | Community | Pro |
| --- | :---: | :---: |
| Boards, lists, cards, real-time collaboration | ✓ | ✓ |
| Markdown, attachments, comments, custom fields | ✓ | ✓ |
| Stopwatch and due dates on cards | ✓ | ✓ |
| Notifications through 100+ providers | ✓ | ✓ |
| Webhooks and a documented REST API | ✓ | ✓ |
| Two-factor authentication | ✓ | ✓ |
| Self-hosted, your database, your backups | ✓ | ✓ |
| **Free to self-host** | **✓** | — |
| Phones and tablets, five themes, accent color | — | ✓ |
| Calendar, timeline, map and media views | — | ✓ |
| Recurring cards, card and board templates | — | ✓ |
| One card on more than one board | — | ✓ |
| Guest roles, SSO (OIDC) | — | ✓ |
| PDF and HTML export | — | ✓ |
| Support from the developers, no ticket queue | — | ✓ |

Pro upgrades an existing Community installation in place — your database, your volume, your
data. It is a real migration rather than a new image: Pro adds a Valkey service and a one-off
schema promote. The promote accepts only certain Community releases as a starting point —
currently 2.1.x and 2.2.x — and from any other version it stops without changing anything.
**The upgrade is one-way — there is no downgrade back to Community — so take a backup first,
or try it on a copy.** The step-by-step guide is in the customer center once you have a key,
and lists the releases the promote accepts.

---

## Key Features

- **Collaborative Kanban Boards:** Create projects, boards, lists, cards, and manage tasks with an intuitive drag-and-drop interface
- **Real-Time Updates:** Instant syncing across all users, no refresh needed
- **Rich Markdown Support:** Write beautifully formatted card descriptions with a powerful markdown editor
- **Flexible Notifications:** Get alerts through 100+ providers, fully customizable to your workflow
- **Multilingual & Easy to Translate:** Full internationalization support for a global audience

## How to Deploy

PLANKA is easy to install using multiple methods - learn more in the [installation guide](https://docs.planka.cloud/docs/welcome/).

For configuration and environment settings, see the [configuration section](https://docs.planka.cloud/docs/category/configuration/).

For hosted plans and pricing, see our [website](https://planka.app/pricing?ref=github-readme).

## Notes App

A testing version of the Notes app is now available on multiple platforms:

- **iOS:** Join the [TestFlight](https://testflight.apple.com/join/5eJqTaJW) to try the app
- **Windows & Android:** Download the app [here](https://planka-notes.hillerdaniel.de)

## Contact

For any security issues, please do not create a public issue on GitHub - instead, report it privately by emailing [security@planka.group](mailto:security@planka.group).

**Note:** We do NOT offer any public support via email, please use GitHub.

**Join our community:** Get help, share ideas, or contribute on our [Discord server](https://discord.gg/WqqYNd7Jvt).

## License

PLANKA is [fair-code](https://faircode.io) distributed under the [Fair Use License](https://github.com/plankanban/planka/blob/master/LICENSES/PLANKA%20Community%20License%20EN.md) and [PLANKA Pro/Enterprise License](https://github.com/plankanban/planka/blob/master/LICENSES/PLANKA%20Commercial%20License%20EN.md).

- **Source Available:** The source code is always visible
- **Self-Hostable:** Deploy and host it anywhere
- **Extensible:** Customize with your own functionality
- **Enterprise Licenses:** Available for additional features and support

For more details, check the [License Guide](https://github.com/plankanban/planka/blob/master/LICENSES/PLANKA%20License%20Guide%20EN.md).

## Contributing

Found a bug or have a feature request? Check out our [Contributing Guide](https://github.com/plankanban/planka/blob/master/CONTRIBUTING.md) to get started.

For setting up the project locally, see the [development section](https://docs.planka.cloud/docs/category/development/).

**Thanks to all our contributors!**

[![Contributors](https://contrib.rocks/image?repo=plankanban/planka)](https://github.com/plankanban/planka/graphs/contributors)