mix/selfpost
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: streamline README quick start section
test / test (push) Has been cancelled
Details

Browse Source 
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
mixeme
2026-08-08 10:48:46 +03:00
parent 7c27dc3b89
commit 0025b5d85d
2 changed files with 2 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -9
View File
@@ -78,10 +78,7 @@ See [DNS setup](docs/guide.md#dns-setup) in the operator guide.
> **First boot — create the admin account.** On a fresh container SelfPost prints > **First boot — create the admin account.** On a fresh container SelfPost prints
> a **one-time setup URL** (valid ten minutes). Open it in a browser to choose > a **one-time setup URL** (valid ten minutes). Open it in a browser to choose
> the administrator username and password. Until you do, the panel has no login. > the administrator username and password. Until you do, the panel has no login.
> How to read the link depends on the path below; production deploy: > Production deploy: [step 3](#3-start-selfpost).
> [step 3](#3-start-selfpost).
### Try it locally
One container, panel at `http://127.0.0.1:8080` — no reverse proxy, no TLS One container, panel at `http://127.0.0.1:8080` — no reverse proxy, no TLS
files, no compose files. Good for clicking through the UI on your machine; files, no compose files. Good for clicking through the UI on your machine;
@@ -117,11 +114,6 @@ docker rm -f selfpost-try && docker volume rm selfpost-try-data
More detail (limitations, optional throwaway TLS for local SMTP): [Local More detail (limitations, optional throwaway TLS for local SMTP): [Local
trial](docs/guide.md#local-trial) in the operator guide. trial](docs/guide.md#local-trial) in the operator guide.
### Deploy for real use
Step-by-step production deploy (compose, reverse proxy, TLS, DNS):
[Reference deploy](#reference-deploy).
## Reference deploy ## Reference deploy
Production layout: one `docker-compose.yml`, a `.env`, persistent `./data`, and Production layout: one `docker-compose.yml`, a `.env`, persistent `./data`, and
docs/guide.md
+1 -1
View File
@@ -53,7 +53,7 @@ printing the `Origin` and `Host` it compared.
## Local trial ## Local trial
The [README quick start](../README.md#try-it-locally) runs a single container The [README quick start](../README.md#quick-start) runs a single container
with `PANEL_COOKIE_SECURE=false` and port 8080 published on localhost. No with `PANEL_COOKIE_SECURE=false` and port 8080 published on localhost. No
reverse proxy, no `./certs` bind mount — Postfix still starts, but the Status reverse proxy, no `./certs` bind mount — Postfix still starts, but the Status
page will report missing TLS material until you mount PEM files at page will report missing TLS material until you mount PEM files at