Skip to content

Commit ca3eb9f

Browse files
committed
minor fixes
1 parent 59aa211 commit ca3eb9f

File tree

2 files changed

+53
-26
lines changed

2 files changed

+53
-26
lines changed
-4.68 KB
Binary file not shown.

self-hosting/methods/airgapped-edition.mdx

Lines changed: 53 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Commercial Airgapped Edition
2+
title: Deploy Plane Commercial Airgapped Edition
33
sidebarTitle: Airgapped Edition
44
---
55

@@ -14,44 +14,66 @@ These instructions are for new installations only. If you're migrating from an e
1414
Before we get started, make sure your air-gapped machine has:
1515

1616
- Docker (version 24 or later) up and running
17-
- Docker Compose Plugin installed (you should be able to run docker compose or docker-compose)
18-
- The Plane air-gapped package (`airgapped.tar.gz`) that we'll provide, which includes:
17+
- Docker Compose Plugin installed (you should be able to run `docker compose` or `docker-compose`)
18+
- The Plane air-gapped package we provide includes:
1919
- Docker image files (`.tar` format)
2020
- Configuration files (`docker-compose.yml` and `plane.env`)
2121
- Installation script (`install.sh`)
2222

23+
### Required files
24+
25+
- `docker-compose.yml` - Docker Compose configuration for service orchestration
26+
- `plane.env` - Default configuration file containing environment variables
27+
- `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
40+
2341
## Install Plane
24-
1. Reach out to support@plane.so to get your installation download URL and the license file.
42+
1. Get in touch with sales@plane.so to get your installation download URL and the license file.
2543

2644
2. On a machine that has internet access, download the installation package:
2745

2846
```bash
2947
curl -LO <asset-download-url>
3048
```
49+
50+
The download may take 15 minutes. Once the file is downloaded you no longer need internet access.
3151

32-
3. Transfer the `airgapped.tar.gz` file to your offline machine using whatever method works in your environment.
52+
3. Transfer the `airgapped-{arch}.tar.gz` file to your air-gapped machine.
3353

3454
4. Once you have the file on your air-gapped machine, extract the package.
3555

3656
```bash
3757
mkdir -p airgapped
38-
tar -xvzf airgapped.tar.gz -C airgapped
58+
tar -xvzf airgapped-amd64.tar.gz -C airgapped
3959
cd airgapped
4060
```
4161

62+
The airgapped directory contains your `plane.env`, `docker-compose.yml`, and `install.sh` files which are used in the following steps.
63+
4264
5. Run the installation script:
4365
```bash
4466
bash install.sh
4567
```
4668

47-
The script will guide you through the process. Here's what to expect:
69+
The script will guide you through the process step by step. Here's what to expect:
4870

49-
The installer will ask you a few questions:
5071
```bash
5172
**********************************************************
5273
You are about to install/upgrade Plane as airgapped setup
5374

54-
Pre-requisites:
75+
Pre-requisites:
76+
5577
- Docker installed and running
5678
- Docker version 24 or higher
5779
- docker-compose or docker compose installed
@@ -76,32 +98,24 @@ Before we get started, make sure your air-gapped machine has:
7698
- Copy the `docker-compose.yml` and `plane.env` files to your chosen installation directory.
7799
- Create the necessary folders for data and logs.
78100
- Load all the Docker images into your local Docker registry.
79-
- Show you the next steps to get Plane running
80101

81102
You'll see something like this when the installation completes:
82103
```bash
83104
**********************************************************
84105
Plane Setup is ready to configure and start
85106

86107
Use below commands to configure and start Plane
87-
88108
Switch to the setup directory
89109
cd /home/ubuntu/planeairgapped
90-
91110
Start the services
92111
docker compose -f docker-compose.yml --env-file plane.env up -d
93-
94112
Check logs of migrator service and wait for it to finish using below command
95113
docker compose logs -f migrator
96-
97114
Check logs of api service and wait for it to start using below command
98115
docker compose logs -f api
99-
100116
Once the api service is started, you can access Plane at http://plane.mycompany.com
101-
102117
**********************************************************
103118
Installation completed successfully
104-
105119
You can access Plane at http://plane.mycompany.com
106120
```
107121

@@ -113,9 +127,15 @@ Before we get started, make sure your air-gapped machine has:
113127
├── data/
114128
└── logs/
115129
```
116-
<Tip>
117-
Once everything is working, you can safely delete the `airgapped` folder that contains the installation script and image files to free up space.
118-
</Tip>
130+
131+
## Environment variables
132+
133+
The following key environment variables are automatically configured during installation:
134+
135+
- `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)
119139

120140
## Start Plane
121141
1. To get Plane up and running, navigate to your installation directory and start the services:
@@ -124,17 +144,19 @@ Once everything is working, you can safely delete the `airgapped` folder that co
124144
docker compose --env-file plane.env up -d
125145
```
126146

127-
2. Watch the logs to make sure everything starts properly:
128-
- Monitor the database migration process:
147+
2. Watch the logs to make sure everything starts properly.
148+
- To monitor the database migration process:
129149
```bash
130150
docker compose logs -f migrator
131151
```
132152

133-
- Monitor the API service startup:
153+
- To monitor the API service startup:
134154
```bash
135155
docker compose logs -f api
136156
```
137157

158+
The api is healthy when you see`: api-1 listening at`
159+
138160
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.
139161

140162
## Activate your license
@@ -144,10 +166,15 @@ Once your air-gapped installation is running, you'll need to activate your works
144166
You should have received the `license_key.json` file as part of your air-gapped package. If you don't have this file, contact our support team.
145167
</Note>
146168

147-
1. Go to your **Workspace Settings** in the Plane application.
169+
1. Go to your [Workspace Settings](/core-concepts/workspaces/overview#workspace-settings) in the Plane application.
148170
2. Select **Billing and plans** on the right pane.
149171
3. Click the **Activate this workspace** button.
150172
![Upload license file](/images/activate-license/upload-license-file.webp)
151173
4. Upload the license file `license_key.json` to activate your workspace.
152-
---
153-
You should now have Plane Business plan running in your air-gapped environment. If you run into any issues, reach out to our support team for assistance.
174+
175+
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.
176+
177+
<Tip>
178+
*Optional*
179+
Once everything is working, you can safely delete the `airgapped` folder that contains the installation script and image files to free up space.
180+
</Tip>

0 commit comments

Comments
 (0)