You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: self-hosting/methods/airgapped-considerations.mdx
+1-58Lines changed: 1 addition & 58 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,64 +11,7 @@ An airgapped deployment operates in a completely isolated network environment wi
11
11
12
12
Plane supports fully airgapped deployments where all components—application services, databases, storage, and integrations—operate entirely within your isolated network perimeter.
13
13
14
-
## Plane architecture overview
15
-
16
-
Plane consists of multiple services working together to provide project management capabilities.
The main application interface where users interact with projects, work items, and pages. This service serves the React-based UI and handles client-side routing.
24
-
25
-
**Space**
26
-
Public project spaces that can be shared externally. This allows teams to publish project information without requiring authentication.
27
-
28
-
**Admin**
29
-
Instance administration interface for workspace owners and administrators. Manages billing, licensing, workspace settings, and user permissions.
30
-
31
-
### API server
32
-
33
-
**API**
34
-
The core REST API that handles all data operations. All frontend services communicate with this API for creating, reading, updating, and deleting data.
35
-
36
-
**Worker**
37
-
Background job processor that handles async operations like file processing, notification dispatch, and data imports. Workers pull jobs from RabbitMQ and execute them independently.
38
-
39
-
**Beat worker**
40
-
Scheduled task executor that runs periodic jobs like data cleanup, report generation, and reminder notifications. Uses a cron-like scheduling system.
41
-
42
-
**Migrator**
43
-
Database schema management service that runs on deployment to apply schema changes and data migrations. Runs once during upgrades then exits.
44
-
45
-
### Supporting services
46
-
47
-
**Live**
48
-
Real-time collaboration service powered by WebSockets. Handles cursor positions, live updates, and presence indicators for multiple users working simultaneously.
49
-
50
-
**Silo**
51
-
Integration backend that manages connections to GitHub, GitLab, and Slack. Handles OAuth flows, webhook processing, and API communication with external systems.
52
-
53
-
**Intake**
54
-
Email ingestion service that converts incoming emails into work items or comments. Requires SMTP configuration and DNS setup.
55
-
56
-
### Infrastructure dependencies
57
-
58
-
**PostgreSQL**
59
-
Primary relational database storing all application data including projects, work items, users, and configuration. Plane requires PostgreSQL 15.7+ or 16.x.
60
-
61
-
**Redis/Valkey**
62
-
In-memory cache and session store. Used for caching frequently accessed data, storing user sessions, and managing real-time collaboration state.
63
-
64
-
**RabbitMQ**
65
-
Message queue for asynchronous task processing. Workers pull jobs from queues for background operations like imports, exports, and notifications.
66
-
67
-
**MinIO/S3**
68
-
Object storage for file uploads, attachments, and generated exports. Can be replaced with any S3-compatible storage system.
69
-
70
-
**OpenSearch**
71
-
Optional search indexing service for enhanced search capabilities. Not required for basic Plane functionality.
14
+
See [Plane architecture](/self-hosting/plane-architecture)
The main application interface where users interact with projects, work items, and pages. This service serves the UI and handles client-side routing.
14
+
15
+
**Space**
16
+
This powers public sharing. It lets you publish projects, views, pages to the web, so others can view without needing to log in.
17
+
18
+
**Admin**
19
+
Instance administration interface for workspace owners and administrators. Manages billing, licensing, workspace settings, and user permissions.
20
+
21
+
### API server
22
+
23
+
**API**
24
+
The core REST API that handles all data operations. All frontend services communicate with this API for creating, reading, updating, and deleting data.
25
+
26
+
**Worker**
27
+
Background job processor that handles async operations like file processing, notification dispatch, and data imports. Workers pull jobs from RabbitMQ and execute them independently.
28
+
29
+
**Beat worker**
30
+
Scheduled task executor that runs periodic jobs like data cleanup, report generation, and reminder notifications. Uses a cron-like scheduling system.
31
+
32
+
**Migrator**
33
+
Database schema management service that runs on deployment to apply schema changes and data migrations. Runs once during upgrades then exits.
34
+
35
+
### Supporting services
36
+
37
+
**Proxy**
38
+
Handles incoming traffic and routes it to the appropriate services. Manages certificates and reverse proxying. In Docker deployments, Plane uses Caddy for automatic SSL certificate management and traffic routing.
39
+
40
+
**Live**
41
+
Real-time collaboration service powered by WebSockets. Handles cursor positions, live updates, and presence indicators for multiple users working simultaneously.
42
+
43
+
**Monitor**
44
+
Used for license validation and activation. It checks the license status and ensures your instance is compliant.
45
+
46
+
**Silo**
47
+
Integration backend that manages connections to GitHub, GitLab, and Slack. Handles OAuth flows, webhook processing, and API communication with external systems.
48
+
49
+
**Intake**
50
+
Email ingestion service that converts incoming emails into work items or comments. Requires SMTP configuration and DNS setup.
51
+
52
+
### Infrastructure dependencies
53
+
54
+
**PostgreSQL**
55
+
Primary relational database storing all application data including projects, work items, users, and configuration. Plane requires PostgreSQL 15.7+ or 16.x.
56
+
57
+
**Redis/Valkey**
58
+
In-memory cache and session store. Used for caching frequently accessed data, storing user sessions, and managing real-time collaboration state.
59
+
60
+
**RabbitMQ**
61
+
Message queue for asynchronous task processing. Workers pull jobs from queues for background operations like imports, exports, and notifications.
62
+
63
+
**MinIO/S3**
64
+
Object storage for file uploads, attachments, and generated exports. Can be replaced with any S3-compatible storage system.
65
+
66
+
**OpenSearch**
67
+
Optional search indexing service for enhanced search capabilities. Not required for basic Plane functionality.
0 commit comments