Welcome to PLANKA Docs

This documentation provides useful information and guides to help you install, configure, and develop PLANKA.

We offer several installation options, depending on your environment and preferences.

📦 Installation

Choose the method that best fits your needs:

🛠️ Manual

• Debian & Ubuntu
• Windows
• Nightly Version - Debian & Ubuntu
• Nightly Version - Windows

🐳 Docker

• Production Version
• Nightly Version
• How to Update
• Backup & Restore

☸️ Kubernetes

• Helm Chart

✅ Automated

• Overview
• Getting Started
• How to Update

---

⬆️ Upgrade to v2

• Manual (Debian & Ubuntu)
• Docker

---

⚙️ Configuration

• Admin User
• Customizing End User Terms
• Run as a Service (Linux)
• Logging
• OIDC (OpenID Connect)
• Importing from Trello

🔁 Reverse Proxy

• Nginx
• Apache
• Traefik (Docker Only)
• Caddy

🔒 Security

• Detailed Authentication Errors
• Fail2Ban

---

📡 API Reference

• Swagger UI
• Postman
• PHP
• Python (plankapy)

---

🧑‍💻 Development

• Set Up Environment

---

❤️ Community

• Projects