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
The `<plane-version>` value should be v1.8.3 or higher.
35
+
:::
36
+
37
+
2.**Configure environment variables**
38
+
Before deploying, edit the `variables.env` file in your preferred text editor and update the following values:
39
+
-`DOMAIN_NAME` – (required) Your application's domain name.
40
+
-`SITE_ADDRESS` – (required) The full domain name (FQDN) of your instance.
41
+
-`MACHINE_SIGNATURE` – (required) A unique identifier for your machine. You can generate this by running below code in terminal:
42
+
```sh
43
+
sed -i 's/MACHINE_SIGNATURE=.*/MACHINE_SIGNATURE='$(openssl rand -hex 16)'/' plane.env
44
+
```
45
+
- `CERT_EMAIL` – (optional) Email address for SSL certificate generation (only needed if you're setting up HTTPS).
43
46
44
47
3. **Configure external DB, Redis, and RabbitMQ**
45
-
::: warning
46
-
When self-hosting Plane for production use, it is strongly recommended to configure external database and storage. This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption.
47
-
:::
48
+
::: warning
49
+
When self-hosting Plane for production use, it is strongly recommended to configure external database and storage. This ensures that your data remains secure and accessible even if the local machine crashes or encounters hardware issues. Relying solely on local storage for these components increases the risk of data loss and service disruption.
50
+
:::
48
51
- `DATABASE_URL` – Connection string for your external database.
49
52
- `REDIS_URL` – Connection string for your external Redis instance.
50
53
- `AMQP_URL` – Connection string for your external RabbitMQ server.
51
54
55
+
4. **Load the environment variables**
56
+
57
+
```bash
58
+
set -o allexport; source <path-to variables.env>; set +o allexport;
59
+
```
52
60
53
-
3. **Load the environment variables**
54
-
```bash
55
-
set -o allexport;source<path-to variables.env>;set +o allexport;
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.
67
+
That's it! This will deploy Plane as a Swarm stack, and your instance should be accessible on your configured domain.
64
68
65
-
5. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features.
69
+
6. If you've purchased a paid plan, [activate your license key](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) to unlock premium features.
0 commit comments