planka README

The project's README from github.com/plankanban/planka. As one markdown file: README.md.

Logo

PLANKA

Project mastering driven by fun

Version Docker Pulls Contributors Chat

Install · Demo · Docs · API · Cloud · Pro version

Demo

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 Features and pricing

Personal dashboard across every project A board on a phone Theme picker Timeline view
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

How to Deploy

PLANKA is easy to install using multiple methods - learn more in the installation guide.

For configuration and environment settings, see the configuration section.

For hosted plans and pricing, see our website.

Notes App

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

Contact

For any security issues, please do not create a public issue on GitHub - instead, report it privately by emailing [email protected].

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.

License

PLANKA is fair-code distributed under the Fair Use License and PLANKA Pro/Enterprise License.

For more details, check the License Guide.

Contributing

Found a bug or have a feature request? Check out our Contributing Guide to get started.

For setting up the project locally, see the development section.

Thanks to all our contributors!

Contributors

planka (plankanban/planka)

Searching Database…

12.6K ·GitHub
Planka
What is this?PLANKA is an open-source, self-hosted Kanban board for team project tracking, pitched as a Trello alternative with a free Community edition and an optional paid Pro edition for organisations.
Is this a web app I host myself, or a hosted SaaS?It's a self-hosted web application you deploy on your own server; PLANKA also sells hosted plans if you don't want to run it yourself.
How do I get PLANKA running?The repo ships a Dockerfile and docker-compose config, and there's a dedicated installation guide covering multiple deployment methods.
What do I need on my server to self-host it?Just a Docker-capable host — the project builds and runs as a Docker image with docker-compose, and configuration/environment settings are documented separately.
If I later want PLANKA Pro, is upgrading risky?Upgrading is a one-way, in-place migration of your existing Community database and volume — it only works from Community versions 2.1.x or 2.2.x, there is no downgrade back to Community, and you're advised to back up first or test on a copy.
Who controls my board data?All data stays on your own infrastructure — your database and your backups, even when moving from Community to Pro.
What's the difference between Community and PLANKA Pro?Community (free) covers boards, lists, cards, real-time collaboration, markdown, webhooks, a documented REST API, and 2FA. Pro adds mobile/tablet apps, five themes, calendar/timeline/map views, recurring cards and templates, guest roles, SSO (OIDC), PDF/HTML export, and direct developer support.
Does PLANKA support single sign-on?SSO via OIDC is a Pro-only feature; the free Community edition doesn't include it.
What is the 'Notes app' mentioned in the README?It's a separate, in-testing companion app (not the core Kanban board) available via TestFlight on iOS and as a download for Windows and Android.
Can I get support if something breaks?Community users get help through the public Discord server and GitHub issues; Pro customers get direct support from the developers without a ticket queue.
What are similar projects?wekan, openproject, taskview-community, leantime, fleetbase, gr8r-studio, casdoor, focalboard
Which topics is it in?fair-source, two-factor-authentication, kanban, project-management, oidc, task-management, webhooks, notifications, collaboration, enterprise, i18n, docker-compose
Creator
plankanban
Size
59.1 MB
Stars
12.6K
Updated
CommitSep 17Releasev2.2.1Aug 10
Age
7y
Commits · 90 Days