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
这是什么？PLANKA 是一款开源、可自托管的看板工具，用于团队项目跟踪，定位为 Trello 的替代品。它提供免费的 Community 版，也为组织提供可选的付费 Pro 版。
这是我自己托管的 Web 应用，还是托管的 SaaS 服务？这是一款可自托管的 Web 应用，你需要部署在自己的服务器上。如果不想自己运行，PLANKA 也提供托管套餐。
我要怎么让 PLANKA 运行起来？代码仓库中提供了 Dockerfile 和 docker-compose 配置，另有一份专门的安装指南，涵盖多种部署方式。
要在自己的服务器上自托管，需要准备什么？只需要一台支持 Docker 的主机即可。该项目以 Docker 镜像的形式构建和运行，并通过 docker-compose 启动；配置和环境变量设置则单独有文档说明。
以后如果想升级到 PLANKA Pro，升级有风险吗？升级是单向的、原地迁移现有 Community 数据库和数据卷的操作。它仅支持从 Community 2.1.x 或 2.2.x 版本升级，无法降级回 Community。建议先备份，或者在副本上测试。
我的看板数据由谁控制？所有数据都保存在你自己的基础设施上，包括数据库和备份。即使从 Community 升级到 Pro，情况也是如此。
Community 版和 PLANKA Pro 有什么区别？Community（免费）版包括看板、列表、卡片、实时协作、Markdown、Webhook、有文档的 REST API 以及双因素认证（2FA）。Pro 版额外提供移动端和平板应用、五种主题、日历/时间线/地图视图、周期性卡片和模板、访客角色、SSO（OIDC）、PDF/HTML 导出，以及开发者的直接支持。
PLANKA 支持单点登录吗？通过 OIDC 实现的 SSO 是 Pro 独有的功能，免费的 Community 版不包含该功能。
README 中提到的“Notes app”是什么？它是一款独立的配套应用，并非核心看板功能，目前仍在测试中。可以通过 iOS 上的 TestFlight 获取，也提供 Windows 和 Android 的下载版本。
遇到问题时可以获得支持吗？Community 用户可以通过公开的 Discord 服务器和 GitHub Issues 获取帮助。Pro 客户则可以直接获得开发者的支持，无需排队等候工单处理。
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