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
7. Upload the license file to activate your workspace.
17
+
18
+
You now have Plane running in your air-gapped environment. If you run into any issues, check the logs, or reach out to our support team for assistance.
Copy file name to clipboardExpand all lines: self-hosting/methods/airgapped-edition-kubernetes.mdx
+5-16Lines changed: 5 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ sidebarTitle: For Kubernetes
8
8
Airgapped deployments are available exclusively for Business plan customers. Contact our [sales team](mailto:sales@plane.so) for pricing and licensing information.
9
9
</Note>
10
10
11
-
This guide walks you through deploying Plane Enterprise in an airgapped Kubernetes environment using Helm charts and pre-packaged Docker images.
11
+
This guide walks you through deploying Plane Commercial in an airgapped Kubernetes environment using Helm charts and pre-packaged Docker images.
12
12
13
13
## What you'll need
14
14
@@ -30,6 +30,7 @@ Consider these alternatives:
30
30
-**Redis**: Replace with Valkey or a managed Redis service
31
31
-**PostgreSQL**: Use a managed PostgreSQL service
32
32
-**RabbitMQ**: Use a managed message queue service
33
+
-**OpenSearch**: Use a managed OpenSearch or Elasticsearch service
33
34
</Warning>
34
35
35
36
## Install Plane
@@ -58,6 +59,7 @@ Consider these alternatives:
58
59
-`rabbitmq:3.13.6-management-alpine`
59
60
-`minio/minio:latest`
60
61
-`minio/mc:latest`
62
+
-`opensearchproject/opensearch:3.3.2`
61
63
62
64
If you're using `local_setup: true` for any of these services, you'll need to pull and transfer these images separately.
63
65
</Note>
@@ -269,22 +271,9 @@ Consider these alternatives:
269
271
kubectl get ingress -n plane -o wide
270
272
```
271
273
272
-
## Activate your license
273
-
274
-
Once your air-gapped installation is running, you'll need to activate your workspace with the license file.
275
-
276
-
1. Login to the [Prime portal](https://prime.plane.so/licenses) with the same email address you used to purchase the paid plan.
277
-
2. Go to [Manage licenses](https://prime.plane.so/licenses).
278
-
3. Click **Download license** to download the license file for your Plane version.
8. Upload the license file to activate your workspace.
285
-
286
-
You now have Plane running in your air-gapped environment. If you run into any issues, check the logs using the commands above, or reach out to our support team for assistance.
274
+
You now have Plane running in your air-gapped environment. If you run into any issues, check the logs using the commands above, or reach out to our support team for assistance.
287
275
276
+
6. [Activate your license key](/self-hosting/manage/manage-licenses/activate-airgapped).
Airgapped deployments are available exclusively for Business plan customers. Contact our [sales team](mailto:sales@plane.so) for pricing and licensing information.
9
9
</Note>
10
10
11
-
This guide walks you through setting up the Commercial Airgapped Edition in an offline environment using our pre-packaged installation bundle.
11
+
This guide walks you through deploying Plane Commercial in an airgapped Docker environment using Docker Compose and pre-configured images from your private registry.
12
12
13
13
## Prerequisites
14
-
Before we get started, make sure your air-gapped machine has:
15
14
16
-
- Docker (version 24 or later) up and running
15
+
Before starting, ensure you have:
16
+
17
+
- Docker (version 24 or later) installed and running
17
18
- Docker Compose Plugin installed (you should be able to run `docker compose` or `docker-compose`)
18
-
- The Plane air-gapped package we provide includes:
19
-
- Docker image files (`.tar` format)
20
-
- Configuration files (`docker-compose.yml` and `plane.env`)
21
-
- Installation script (`install.sh`)
22
-
23
-
### Required files
24
-
25
-
-`docker-compose.yml` - Docker Compose configuration for service orchestration
-`admin-commercial-<version>.tar` - Docker image for admin service
28
-
-`backend-commercial-<version>.tar` - Docker image for api/worker/beat-worker/migrator service
29
-
-`email-commercial-<version>.tar` - Docker image for email service
30
-
-`live-commercial-<version>.tar` - Docker image for live service
31
-
-`monitor-commercial-<version>.tar` - Docker image for monitor service
32
-
-`proxy-commercial-<version>.tar` - Docker image for plane-proxy service
33
-
-`silo-commercial-<version>.tar` - Docker image for silo service
34
-
-`space-commercial-<version>.tar` - Docker image for space service
35
-
-`web-commercial-<version>.tar` - Docker image for web service
36
-
-`minio-latest.tar` - Docker image for plane-minio service
37
-
-`postgres-15.7-alpine.tar` - Docker image for plane-db service
38
-
-`rabbitmq-3.13.6-management-alpine.tar` - Docker image for plane-mq service
39
-
-`valkey-7.2.5-alpine.tar` - Docker image for plane-redis service
19
+
- Access to a private Docker registry containing Plane images
20
+
- Required ports opened to access the application (80, 443)
21
+
22
+
<Warning>
23
+
While Docker can run stateful services with persistent volumes, we strongly recommend using external managed services for better reliability in backup/restore operations and disaster recovery.
24
+
25
+
Consider these alternatives:
26
+
-**MinIO**: Replace with AWS S3, Google Cloud Storage, or any S3-compatible service
27
+
-**Redis**: Replace with Valkey or a managed Redis service
28
+
-**PostgreSQL**: Use a managed PostgreSQL service
29
+
-**RabbitMQ**: Use a managed message queue service
30
+
-**OpenSearch**: Use a managed OpenSearch or Elasticsearch service
31
+
</Warning>
40
32
41
33
## Install Plane
42
-
1. Get in touch with sales@plane.so to get your installation download URL and the license file.
43
34
44
-
2. On a machine that has internet access, download the installation package:
35
+
1.**Prepare Docker images for airgapped environment**
45
36
46
-
```bash
47
-
curl -LO <asset-download-url>
48
-
```
49
-
50
-
The download may take 15 minutes. Once the file is downloaded you no longer need internet access.
37
+
Refer to [this document](/self-hosting/methods/clone-docker-images) to download the Docker images from the Plane artifact registry to your internal registry.
51
38
52
-
3. Transfer the `airgapped-{arch}.tar.gz` file to your air-gapped machine.
39
+
<Note>
40
+
**Important**
41
+
This process will NOT download or clone these infrastructure images:
42
+
-`valkey/valkey:7.2.11-alpine`
43
+
-`postgres:15.7-alpine`
44
+
-`rabbitmq:3.13.6-management-alpine`
45
+
-`minio/minio:latest`
46
+
-`minio/mc:latest`
47
+
-`opensearchproject/opensearch:3.3.2`
53
48
54
-
4. Once you have the file on your air-gapped machine, extract the package.
49
+
If you're using local infrastructure services, you'll need to pull and transfer these images separately.
50
+
</Note>
55
51
56
-
```bash
57
-
mkdir -p airgapped
58
-
tar -xvzf airgapped-amd64.tar.gz -C airgapped
59
-
cd airgapped
60
-
```
52
+
2.**Download Docker Compose configuration**
61
53
62
-
The airgapped directory contains your `plane.env`, `docker-compose.yml`, and `install.sh`files which are used in the following steps.
54
+
Download the Docker Compose configuration files from the official release.
-`MACHINE_SIGNATURE` - A unique UUID generated for your installation
136
-
-`DOMAIN_NAME` - The domain or IP address where Plane will be accessible
137
-
-`WEB_URL` - The full URL where Plane will be accessible (e.g., `http://your-domain`)
138
-
-`CORS_ALLOWED_ORIGINS` - Allowed origins for CORS (Cross-Origin Resource Sharing)
104
+
**Infrastructure services** (if using local setup):
105
+
```yaml
106
+
services:
107
+
redis:
108
+
image: valkey/valkey:7.2.11-alpine
109
+
110
+
postgres:
111
+
image: postgres:15.7-alpine
112
+
113
+
rabbitmq:
114
+
image: rabbitmq:3.13.6-management-alpine
115
+
116
+
minio:
117
+
image: minio/minio:latest
118
+
```
139
119
140
120
## Start Plane
141
-
1. To get Plane up and running, navigate to your installation directory and start the services:
121
+
122
+
1. Start the services:
142
123
```bash
143
-
cd~/planeairgapped
144
124
docker compose --env-file plane.env up -d
145
125
```
146
126
@@ -155,22 +135,10 @@ The following key environment variables are automatically configured during inst
155
135
docker compose logs -f api
156
136
```
157
137
158
-
The api is healthy when you see`: api-1 listening at`
159
-
160
-
Once both services are running smoothly, you can access Plane by opening your browser and going to the domain or IP address you configured during installation.
161
-
162
-
## Activate your license
138
+
The API is healthy when you see: `api-1 listening at`
163
139
164
-
Once your air-gapped installation is running, you'll need to activate your workspace with the license file.
165
-
166
-
1. Login to the [Prime portal](https://prime.plane.so/licenses) with the same email address you used to purchase the paid plan.
167
-
2. Go to [Manage licenses](https://prime.plane.so/licenses).
168
-
3. Click **Download license** to download the license file for your Plane version.
7. Upload the license file to activate your workspace.
140
+
Once all services are running smoothly, you can access Plane by opening your browser and going to the domain you configured.
141
+
142
+
You now have Plane running in your air-gapped environment. If you run into any issues, check the logs using the commands above, or reach out to our support team for assistance.
175
143
176
-
You now have Plane running in your air-gapped environment. If you run into any issues, check the logs using the commands above, or reach out to our support team for assistance.
144
+
3.[Activate your license key](/self-hosting/manage/manage-licenses/activate-airgapped)
0 commit comments