Skip to content

Commit 6c8c725

Browse files
sriramveeraghantasriramveeraghanta
committed
fix: indentation
1 parent a011746 commit 6c8c725

File tree

7 files changed

+469
-459
lines changed

7 files changed

+469
-459
lines changed

‎docs/self-hosting/govern/configure-dns-email-service.md‎

Lines changed: 84 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -27,105 +27,114 @@ Before configuring DNS records for Intake Email, secure your email domain with a
2727

2828
1. **Install Certbot**
2929
Update your system and install Certbot.
30-
`bash
31-
sudo apt update && sudo apt install certbot
32-
`
30+
31+
```bash
32+
sudo apt update && sudo apt install certbot
33+
```
34+
3335
For NGINX:
34-
`bash
35-
sudo apt install python3-certbot-nginx
36-
`
36+
37+
```bash
38+
sudo apt install python3-certbot-nginx
39+
```
40+
3741
For Apache:
38-
`bash
39-
sudo apt install python3-certbot-apache
40-
`
4142

42-
2. **Generate SSL Certificate**
43+
```bash
44+
sudo apt install python3-certbot-apache
45+
```
46+
47+
2. **Generate SSL Certificate**
4348
Choose the method that matches your web server setup:
4449

45-
For NGINX:
46-
```bash
47-
sudo certbot --nginx -d <mail-domain>
48-
```
50+
For NGINX:
51+
52+
```bash
53+
sudo certbot --nginx -d <mail-domain>
54+
```
55+
56+
For Apache:
57+
58+
```bash
59+
sudo certbot --apache -d <mail-domain>
60+
```
4961

50-
For Apache:
51-
```bash
52-
sudo certbot --apache -d <mail-domain>
53-
```
62+
For standalone (no web server):
5463

55-
For standalone (no web server):
56-
```bash
57-
sudo certbot certonly --standalone -d <mail-domain>
58-
```
64+
```bash
65+
sudo certbot certonly --standalone -d <mail-domain>
66+
```
5967

60-
3. **Copy Certificate Files**
68+
3. **Copy Certificate Files**
6169
Copy the generated certificate files to Plane's expected directory:
6270
63-
```bash
64-
sudo cp /etc/letsencrypt/live/<mail-domain>/fullchain.pem /opt/plane/data/email/tls/cert.pem
65-
sudo cp /etc/letsencrypt/live/<mail-domain>/privkey.pem /opt/plane/data/email/tls/key.pem
66-
```
71+
```bash
72+
sudo cp /etc/letsencrypt/live/<mail-domain>/fullchain.pem /opt/plane/data/email/tls/cert.pem
73+
sudo cp /etc/letsencrypt/live/<mail-domain>/privkey.pem /opt/plane/data/email/tls/key.pem
74+
```
6775
68-
4. **Configure Environment Variables**
76+
4. **Configure Environment Variables**
6977
Add the following settings to your plane.env file:
7078
71-
```bash
72-
# If using SMTP_DOMAIN as FQDN (e.g., intake.example.com),
73-
# generate a valid SSL certificate and set these paths accordingly.
74-
SMTP_DOMAIN=intake.example.com
75-
TLS_CERT_PATH=tls/cert.pem
76-
TLS_PRIV_KEY_PATH=tls/key.pem
77-
INTAKE_EMAIL_DOMAIN=intake.example.com
78-
```
79+
```bash
80+
# If using SMTP_DOMAIN as FQDN (e.g., intake.example.com),
81+
# generate a valid SSL certificate and set these paths accordingly.
82+
SMTP_DOMAIN=intake.example.com
83+
TLS_CERT_PATH=tls/cert.pem
84+
TLS_PRIV_KEY_PATH=tls/key.pem
85+
INTAKE_EMAIL_DOMAIN=intake.example.com
86+
```
7987
80-
::: warning
81-
Important: `SMTP_DOMAIN` and `INTAKE_EMAIL_DOMAIN` must be identical.
82-
:::
88+
::: warning
89+
Important: `SMTP_DOMAIN` and `INTAKE_EMAIL_DOMAIN` must be identical.
90+
:::
8391
8492
## Configure DNS records
8593
86-
1. **Create an A Record**
94+
1. **Create an A Record**
8795
This record points to the server running your email service.
8896
89-
```bash
90-
Type: A
91-
Host: <host-domain> # Example: plane.example.com
92-
Value: <public-ip-address> # Your server's public IP address
93-
TTL: Auto | 3600
94-
```
95-
96-
::: tip
97-
You can alternatively use a CNAME record if you're using a cloud load balancer.
98-
:::
99-
100-
2. **Add an MX Record**
101-
This record directs email traffic to your mail server.
102-
`bash
103-
Type: MX
104-
Host: <mail-domain> # Example: intake.example.com
105-
Value: <host-domain> # Same as your A record host
106-
Priority: 10
107-
TTL: Auto | 3600
108-
`
109-
110-
3. **Configure an SPF Record**
97+
```bash
98+
Type: A
99+
Host: <host-domain> # Example: plane.example.com
100+
Value: <public-ip-address> # Your server's public IP address
101+
TTL: Auto | 3600
102+
```
103+
104+
::: tip
105+
You can alternatively use a CNAME record if you're using a cloud load balancer.
106+
:::
107+
108+
2. **Add an MX Record**
109+
This record directs email traffic to your mail server.
110+
111+
```bash
112+
Type: MX
113+
Host: <mail-domain> # Example: intake.example.com
114+
Value: <host-domain> # Same as your A record host
115+
Priority: 10
116+
TTL: Auto | 3600
117+
```
118+
119+
3. **Configure an SPF Record**
111120
This record helps prevent email spoofing.
112121
113-
```bash
114-
Type: TXT
115-
Host: <mail-domain> # Example: intake.example.com
116-
Value: "v=spf1 ip4:<A-record-ip-host-domain> -all"
117-
TTL: Auto | 3600
118-
```
122+
```bash
123+
Type: TXT
124+
Host: <mail-domain> # Example: intake.example.com
125+
Value: "v=spf1 ip4:<A-record-ip-host-domain> -all"
126+
TTL: Auto | 3600
127+
```
119128
120-
4. **Set Up a DMARC record**
129+
4. **Set Up a DMARC record**
121130
This record specifies how receiving mail servers should handle authentication failures.
122131
123-
```bash
124-
Type: TXT
125-
Host: _dmarc.<mail-domain> # Example: _dmarc.intake.example.com
126-
Value: "v=DMARC1; p=reject; rua=mailto:<valid-email-addr>"
127-
TTL: Auto | 3600
128-
```
132+
```bash
133+
Type: TXT
134+
Host: _dmarc.<mail-domain> # Example: _dmarc.intake.example.com
135+
Value: "v=DMARC1; p=reject; rua=mailto:<valid-email-addr>"
136+
TTL: Auto | 3600
137+
```
129138
130139
## Verify your configuration
131140

‎docs/self-hosting/govern/custom-domain.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ cat /opt/plane/plane.env | grep <old_domain>
2929

3030
**Example output:**
3131

32-
```env
32+
```ini
3333
DOMAIN_NAME=localhost
3434
SITE_ADDRESS=http://localhost
3535
WEB_URL=http://localhost
@@ -51,7 +51,7 @@ This shows you all the variables that contain your current domain. You'll update
5151

5252
Set this to your bare domain name without protocol:
5353

54-
```env
54+
```ini
5555
DOMAIN_NAME=plane.company.com
5656
```
5757

@@ -60,7 +60,7 @@ This shows you all the variables that contain your current domain. You'll update
6060

6161
Set this to your full domain URL:
6262

63-
```env
63+
```ini
6464
SITE_ADDRESS=https://plane.company.com
6565
```
6666

@@ -69,7 +69,7 @@ This shows you all the variables that contain your current domain. You'll update
6969

7070
This should match your SITE_ADDRESS:
7171

72-
```env
72+
```ini
7373
WEB_URL=https://plane.company.com
7474
```
7575

@@ -79,7 +79,7 @@ This shows you all the variables that contain your current domain. You'll update
7979

8080
List all domains that should be allowed to make cross-origin requests to your Plane instance. This typically includes both HTTP and HTTPS versions of your domain:
8181

82-
```env
82+
```ini
8383
CORS_ALLOWED_ORIGINS=https://plane.company.com,http://plane.company.com
8484
```
8585

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ If you need to change your domain during migration, contact our support team for
3434

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

37-
::: warning
38-
**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`.
39-
:::
37+
::: warning
38+
**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`.
39+
:::
4040

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

‎docs/self-hosting/methods/coolify.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,16 @@ This guide shows you the steps to deploy a self-hosted instance of Plane using C
1818
### Procedure
1919

2020
1. **Download the required depoyment files**
21-
- `coolify-compose.yml` – Defines Plane's services and dependencies.
2221

23-
```bash
24-
curl -fsSL https://prime.plane.so/releases/<plane-version>/coolify-compose.yml -o coolify-compose.yml
25-
```
22+
`coolify-compose.yml` – Defines Plane's services and dependencies.
2623

27-
::: warning
28-
The `<plane-version>` value should be v1.8.2 or higher.
29-
:::
24+
```bash
25+
curl -fsSL https://prime.plane.so/releases/<plane-version>/coolify-compose.yml -o coolify-compose.yml
26+
```
27+
28+
::: warning
29+
The `<plane-version>` value should be v1.8.2 or higher.
30+
:::
3031

3132
2. Create a new project in Coolify.
3233

0 commit comments

Comments
 (0)