Skip to content

Commit eefc49a

Browse files
committed
docs: move TLS setup instructions to README top
1 parent b71508a commit eefc49a

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Basicrum, single-server community edition
22

3+
## HTTPS setup
4+
5+
Choose how HTTPS will be configured before installing:
6+
7+
- **Cloudflare:** use a proxied DNS record, create an Origin CA certificate for
8+
your hostname, and set Cloudflare SSL/TLS to **Full (strict)**. Then run:
9+
10+
```bash
11+
curl -fsSL https://github.com/basicrum/basicrum-single-instance-community/releases/latest/download/install.sh | bash -s -- \
12+
--domain rum.example.com --tls cloudflare \
13+
--cert /path/to/origin.pem --key /path/to/origin.key --yes
14+
```
15+
16+
- **Let's Encrypt:** point the hostname to this server and allow inbound ports
17+
80 and 443. Traefik obtains and renews the certificate automatically:
18+
19+
```bash
20+
curl -fsSL https://github.com/basicrum/basicrum-single-instance-community/releases/latest/download/install.sh | bash -s -- \
21+
--domain rum.example.com --tls letsencrypt --email you@example.com --yes
22+
```
23+
24+
See [Cloudflare proxy](#cloudflare-proxy) and [Let's Encrypt](#letsencrypt)
25+
for certificate, DNS, and troubleshooting details.
26+
327
## Install or update
428

529
Run this command on the server. Docker must already be installed and running.

0 commit comments

Comments
 (0)