Plane

Plane is an open source project collaboration platform, including frontend, backend, PostgreSQL, Redis, and S3/MinIO storage.

⚠️ Note:

1. Make sure to bind your domain to the plane service, as it is the single entry point for accessing your Plane platform.
2. Due to Plane issue #7027, you need to manually restart the api service once after deployment.
3. You also need to manually bind a domain to your MinIO service and access the MinIO Console (port 9090). In the Console, set the uploads bucket to public so that you can successfully upload and view images. This step must be performed manually by the user.

Usage

The plane service acts as the entry point for your Plane instance. It is a Caddy reverse proxy that routes all traffic to the appropriate services. You should bind your custom domain to this service to access your Plane platform.

Key features of the entry service:

• Handles all incoming HTTP/HTTPS traffic
• Routes requests to the correct services (web, api, admin, etc.)
• Provides SSL/TLS termination
• Manages domain binding and routing rules

Services

This Plane instance includes the following services:

• PostgreSQL: Database for storing all project and user data.
• Redis: Caching and background task queue.
• MinIO: S3-compatible object storage for file uploads and attachments.
• API: Django backend, provides all business logic and API endpoints.
• Worker: Celery worker for background jobs and async tasks.
• Beat Worker: Celery beat for scheduled tasks.
• Web: Next.js frontend for user interface.
• Admin: Admin dashboard for managing the platform.
• Space: Space module for additional collaboration features.
• Plane: Caddy reverse proxy, routes all traffic to the correct service.

Configuration

• Domain: Bind your custom domain to the Plane service for public access.
• Environment Variables: You can customize database, Redis, and MinIO credentials in the service environment variables.
• S3/MinIO: By default, MinIO is used for file storage. You can connect your own S3-compatible storage if needed.

Advanced

• For more information, visit the Plane documentation.
• If you need to customize the deployment, refer to the official Plane GitHub repository.
• For troubleshooting and community support, join the Plane Discord.

---

Plane is dedicated to helping teams work more efficiently. It includes features like built-in tasks, files, and real-time updates. Enjoy building your own Plane!