Skip to content
Klutch.sh Docs

Deploying a Plane App

Introduction

Plane is an open-source project management and issue-tracking platform built with a modern React front end and a Django-based API. Deploying Plane with a Dockerfile on Klutch.sh provides reproducible builds, managed secrets, and persistent storage for attachments and logs—all configured from klutch.sh/app. This guide covers installation, repository prep, a production-ready Dockerfile, deployment steps, Nixpacks overrides, sample API usage, and production tips.

Prerequisites

  • A Klutch.sh account (sign up)
  • A GitHub repository containing your Plane Dockerfile (GitHub is the only supported git source)
  • PostgreSQL database (deploy as a Klutch.sh TCP app on port 8000; connect on 5432)
  • Redis instance (deploy as a Klutch.sh TCP app on port 8000; connect on 6379)
  • Domain and TLS for secure access

For onboarding, see the Quick Start.

Architecture and ports

  • Plane serves HTTP on internal port 3000; choose HTTP traffic.
  • Persistent storage is required for uploads and logs.

Repository layout

plane/
├── Dockerfile              # Must be at repo root for auto-detection
└── README.md

Keep secrets out of Git; store them in Klutch.sh environment variables.

Installation (local) and starter commands

Validate locally before pushing to GitHub:

Terminal window
docker build -t plane-local .
docker run -p 3000:3000 \
  -e DATABASE_URL=postgres://user:pass@localhost:5432/plane \
  -e REDIS_URL=redis://localhost:6379/0 \
  -e SECRET_KEY=changeme \
  plane-local

Dockerfile for Plane (production-ready)

Place this Dockerfile at the repo root; Klutch.sh auto-detects it (no Docker selection in the UI):

FROM makeplane/plane:latest


ENV PORT=3000


EXPOSE 3000
CMD ["bash", "-lc", "export PORT=${PORT}; npm run start"]

Notes:

  • Pin the image tag (e.g., makeplane/plane:v0.x) for stability; update intentionally.
  • If you maintain your own build, adjust the start command to your package script.

Environment variables (Klutch.sh)

Set these in Klutch.sh before deploying:

  • PORT=3000
  • DATABASE_URL=postgres://<user>:<password>@<db-host>:5432/<db>
  • REDIS_URL=redis://:<password>@<redis-host>:6379/0
  • SECRET_KEY=<secure-random>
  • Optional: APP_BASE_URL=https://example-app.klutch.sh, SMTP settings for notifications

If you deploy without the Dockerfile and need Nixpacks overrides:

  • NIXPACKS_BUILD_CMD=npm install && npm run build
  • NIXPACKS_START_CMD=npm run start
  • NIXPACKS_NODE_VERSION=18

Attach persistent volumes

In Klutch.sh storage settings, add mount paths and sizes (no names required):

  • /app/uploads — file attachments and media.
  • /app/logs — optional logs if stored on disk.

Ensure these paths are writable inside the container.

Deploy Plane on Klutch.sh (Dockerfile workflow)

  1. Push your repository—with the Dockerfile at the root—to GitHub.
  2. Open klutch.sh/app, create a project, and add an app.
  3. Select HTTP traffic and set the internal port to 3000.
  4. Add the environment variables above, including database, Redis, and secrets.
  5. Attach persistent volumes for /app/uploads (and /app/logs if used) sized for your storage and retention needs.
  6. Deploy. Your Plane instance will be reachable at https://example-app.klutch.sh; attach a custom domain if desired.

Sample API usage

List projects (replace token with an API token):

Terminal window
curl -X GET "https://example-app.klutch.sh/api/projects" \
  -H "Authorization: Bearer <token>"

Create an issue:

Terminal window
curl -X POST "https://example-app.klutch.sh/api/issues" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"title":"Hello from Plane on Klutch.sh","description":"Example issue"}'

Health checks and production tips

  • Add an HTTP probe to /api/health or / for readiness.
  • Enforce HTTPS at the edge; forward internally to port 3000.
  • Keep DB/Redis credentials and SECRET_KEY in Klutch.sh secrets; rotate them regularly.
  • Monitor storage usage on /app/uploads; resize before it fills.
  • Pin image versions and test upgrades in staging; back up DB and uploads before updates.

Plane on Klutch.sh combines reproducible Docker builds with managed secrets, persistent storage, and flexible HTTP/TCP routing. With the Dockerfile at the repo root, port 3000 configured, and Postgres/Redis connected, you can deliver collaborative project management without extra YAML or workflow overhead.