Skip to content

Commit 1ba35cc

Browse files
fix: formatting
1 parent 9e6214b commit 1ba35cc

File tree

4 files changed

+65
-62
lines changed

4 files changed

+65
-62
lines changed

docs/self-hosting/govern/environment-variables.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ This guide provides a comprehensive overview of all environment variables used i
1111
## Where to find the .env file
1212

1313
The environment file for Plane Commercial Edition is located at:
14-
`bash
15-
/opt/plane/plane.env
16-
`
14+
15+
```bash
16+
/opt/plane/plane.env
17+
```
1718

1819
This is where you'll make all configuration changes. Remember to restart the instance after making changes to ensure they take effect.
1920

@@ -164,9 +165,10 @@ This guide provides a comprehensive overview of all environment variables availa
164165
## Where to find the environment file
165166

166167
The environment configuration file is located at:
167-
`bash
168-
plane-selfhost/plane-app/plane.env
169-
`
168+
169+
```bash
170+
plane-selfhost/plane-app/plane.env
171+
```
170172

171173
## Environment Variables
172174

docs/self-hosting/govern/integrations/gitlab.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -72,37 +72,37 @@ After creating and configuring the GitLab application and configuring the instan
7272
3. From the dropdown menu that appears, select **Edit profile**.
7373
4. Look for and select the **Applications** option within this menu.
7474
5. On the Applications page, click **Add new application** to begin configuring your OAuth application.
75-
76-
Fill in the application details with the following configuration:
7775

78-
- **Name**
79-
Enter a descriptive name for your application (e.g., `Plane Local Dev` or `Plane Integration`).
76+
Fill in the application details with the following configuration:
8077

81-
- **Redirect URI**
82-
The redirect URI depends on your Plane deployment:
78+
- **Name**
79+
Enter a descriptive name for your application (e.g., `Plane Local Dev` or `Plane Integration`).
8380

84-
**For Plane Cloud:**
85-
86-
`https://silo.plane.so/api/oauth/gitlab-enterprise/auth/callback`
81+
- **Redirect URI**
82+
The redirect URI depends on your Plane deployment:
8783

88-
**For Plane Self-Hosted:**
89-
90-
`https://<your-domain>/silo/api/oauth/gitlab-enterprise/auth/callback`
84+
**For Plane Cloud:**
9185

92-
Replace `<your-domain>` with your actual Plane instance domain.
86+
`https://silo.plane.so/api/oauth/gitlab-enterprise/auth/callback`
9387

94-
- **Confidential**
95-
Keep the **Confidential** checkbox enabled. This ensures the application uses a client secret for secure authentication.
88+
**For Plane Self-Hosted:**
9689

97-
- **Scopes**
98-
Select the following scopes to grant Plane the necessary permissions:
90+
`https://<your-domain>/silo/api/oauth/gitlab-enterprise/auth/callback`
9991

100-
- **api** - Grants complete read/write access to the API, including all groups and projects
101-
- **read_api** - Grants read access to the API, including all groups and projects
102-
- **read_user** - Grants read-only access to your profile information
103-
- **read_repository** - Grants read-only access to repositories on private projects
104-
- **profile** - Grants read-only access to the user's profile data using OpenID Connect
105-
- **email** - Grants read-only access to the user's primary email address using OpenID Connect
92+
Replace `<your-domain>` with your actual Plane instance domain.
93+
94+
- **Confidential**
95+
Keep the **Confidential** checkbox enabled. This ensures the application uses a client secret for secure authentication.
96+
97+
- **Scopes**
98+
Select the following scopes to grant Plane the necessary permissions:
99+
100+
- **api** - Grants complete read/write access to the API, including all groups and projects
101+
- **read_api** - Grants read access to the API, including all groups and projects
102+
- **read_user** - Grants read-only access to your profile information
103+
- **read_repository** - Grants read-only access to repositories on private projects
104+
- **profile** - Grants read-only access to the user's profile data using OpenID Connect
105+
- **email** - Grants read-only access to the user's primary email address using OpenID Connect
106106

107107
6. Click **Save application** to create the OAuth application.
108108

docs/self-hosting/manage/migrate-plane.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ If you need to change your domain during migration, contact our support team for
2323
## Steps
2424

2525
1. **Delink licenses**
26-
Log in to Plane on your current server. Head to each paid workspace like Pro or Business and [delink the licenses](/self-hosting/manage/manage-licenses/activate-pro-and-business#delink-license-key). This will free up the licenses for activation on your new server. Ideally, you have just one paid workspace.
26+
Log in to Plane on your current server. Head to each paid workspace like Pro or Business and [delink the licenses](/self-hosting/manage/manage-licenses/activate-pro-and-business#delink-license-key). This will free up the licenses for activation on your new server. Ideally, you have just one paid workspace.
2727

2828
2. **Backup data**
29-
Create a backup of your Plane instance with ↓:
29+
Create a backup of your Plane instance with ↓:
3030

31-
```bash
32-
prime-cli backup
33-
```
31+
```bash
32+
prime-cli backup
33+
```
3434

3535
This command will generate a backup file in the path: `/opt/plane/backups`.
3636

@@ -39,21 +39,21 @@ This command will generate a backup file in the path: `/opt/plane/backups`.
3939
:::
4040

4141
3. **Set up Plane on the new server**
42-
Follow the [installation guide](/self-hosting/methods/docker-compose#install-plane) to deploy Plane on the new instance.
42+
Follow the [installation guide](/self-hosting/methods/docker-compose#install-plane) to deploy Plane on the new instance.
4343

4444
4. **Transfer backup files**
45-
Copy the `backups` folder from the old server, created in step 2, to the new server. Place the backup in the folder `/opt/plane`.
45+
Copy the `backups` folder from the old server, created in step 2, to the new server. Place the backup in the folder `/opt/plane`.
4646

4747
5. **Restore data**
48-
On the new server, restore your data with ↓:
48+
On the new server, restore your data with ↓:
4949

50-
```bash
51-
prime-cli restore
52-
```
50+
```bash
51+
prime-cli restore
52+
```
5353

5454
Follow the prompts during the restore process to make sure everything is set up correctly.
5555

5656
6. **Reactivate license**
57-
Finally, [reactivate your license keys](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) on the new instance.
57+
Finally, [reactivate your license keys](/self-hosting/manage/manage-licenses/activate-pro-and-business#activate-your-license) on the new instance.
5858

5959
This should get your Plane instance up and running on the new server.

docs/self-hosting/upgrade-from-community.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -86,27 +86,28 @@ This upgrade path is for installations using external or managed database and ob
8686
1. Find the `DATABASE_URL` environment variable.
8787
2. Verify it points to your external database:
8888

89-
```ini
90-
DATABASE_URL=postgresql://user:password@your-db-host:5432/plane
91-
```
92-
93-
If you need to change it, update the value with your managed database connection string.
94-
3. Configure object storage
95-
1. Find the `#DATASTORE SETTINGS` section in `plane.env`
96-
2. Update these environment variables for your external storage:
97-
98-
```ini
99-
USE_MINIO=0
100-
AWS_REGION=us-east-1
101-
AWS_ACCESS_KEY_ID=<your-access-key>
102-
AWS_SECRET_ACCESS_KEY=<your-secret-key>
103-
AWS_S3_ENDPOINT_URL=https://s3.amazonaws.com
104-
AWS_S3_BUCKET_NAME=plane-uploads
105-
```
106-
107-
:::info
108-
Setting `USE_MINIO=0` disables the local MinIO service and enables external object storage (S3 or S3-compatible services).
109-
:::
89+
```ini
90+
DATABASE_URL=postgresql://user:password@your-db-host:5432/plane
91+
```
92+
93+
If you need to change it, update the value with your managed database connection string.
94+
95+
3. Configure object storage
96+
1. Find the `#DATASTORE SETTINGS` section in `plane.env`
97+
2. Update these environment variables for your external storage:
98+
99+
```ini
100+
USE_MINIO=0
101+
AWS_REGION=us-east-1
102+
AWS_ACCESS_KEY_ID=<your-access-key>
103+
AWS_SECRET_ACCESS_KEY=<your-secret-key>
104+
AWS_S3_ENDPOINT_URL=https://s3.amazonaws.com
105+
AWS_S3_BUCKET_NAME=plane-uploads
106+
```
107+
108+
:::info
109+
Setting `USE_MINIO=0` disables the local MinIO service and enables external object storage (S3 or S3-compatible services).
110+
:::
110111

111112
3. Restart Plane services to apply the configuration:
112113
```bash

0 commit comments

Comments
 (0)