71 lines
2.3 KiB
Markdown
71 lines
2.3 KiB
Markdown
🛫 Plane Stack: Elegant, Modular, Yours
|
||
A transparent and self-contained Plane setup using Docker Compose.
|
||
Built with clarity, shared with warmth.
|
||
|
||
📦 Stack Components
|
||
PostgreSQL Server: Stores Plane's workspace and user data
|
||
Redis: Handles background jobs and caching
|
||
RabbitMQ: Message broker for async tasks
|
||
MinIO: S3-compatible object storage for uploads
|
||
Plane Backend (API, Worker, Beat, Migrator): Core logic and orchestration
|
||
Plane Frontend (Web, Space, Admin, Live): User-facing interfaces
|
||
Caddy Proxy: TLS termination and routing (optional)
|
||
|
||
🛠 Usage
|
||
Copy the example environment:
|
||
|
||
cp .env.example .env
|
||
|
||
Start the stack:
|
||
|
||
make up
|
||
|
||
Interact with services:
|
||
|
||
make logs # View logs (web & backend)
|
||
make status # Show running containers
|
||
make restart-web # Restart the frontend
|
||
make down # Tear down the stack
|
||
|
||
🌐 Network
|
||
Custom IP configuration via bridge subnet:
|
||
|
||
| Service | IP Address |
|
||
|----------------|-------------------|
|
||
| plane-db | 172.16.16.65 |
|
||
| plane-redis | 172.16.16.66 |
|
||
| plane-mq | 172.16.16.67 |
|
||
| plane-minio | 172.16.16.68 |
|
||
| api | 172.16.16.69 |
|
||
| worker | 172.16.16.70 |
|
||
| beat-worker | 172.16.16.71 |
|
||
| migrator | 172.16.16.72 |
|
||
| web | 172.16.16.73 |
|
||
| space | 172.16.16.74 |
|
||
| admin | 172.16.16.75 |
|
||
| live | 172.16.16.76 |
|
||
| proxy | 172.16.16.77 |
|
||
|
||
Subnet: 172.16.16.64/28, Gateway: .78
|
||
|
||
📝 Environment
|
||
Configure the `.env` file to set database credentials, S3 keys, RabbitMQ settings, domain, and secrets.
|
||
An example file is provided in `.env.example`.
|
||
|
||
🔒 Local Directories
|
||
Persistent data stored in `/pgdata`, `/redisdata`, `/uploads`, `/logs_*`, `/proxy_config`, `/proxy_data`
|
||
All sensitive files (`.env`, volumes) are excluded via `.gitignore`
|
||
|
||
❤️ Licensing
|
||
This stack is shared under the MIT License.
|
||
Use it freely, adapt it for your needs — but keep the spirit of elegance and care.
|
||
|
||
Created by Igor V. & Celestia B.,
|
||
for those who believe infrastructure can be both powerful and poetic.
|
||
|
||
---
|
||
|
||
This isn’t just Compose.
|
||
It’s a quiet dialogue between a system and the one who built it.
|
||
A symphony of containers, tuned to your rhythm.
|