From 03c966919fa3131c709a958e485a2af82ed122e6 Mon Sep 17 00:00:00 2001 From: Leo Vasanko Date: Fri, 19 Dec 2025 14:59:22 +0000 Subject: [PATCH] README formatting and links. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7eda4ae..d558f00 100644 --- a/README.md +++ b/README.md @@ -55,18 +55,18 @@ There is no config file. Pass only the options on CLI: paskia serve [options] ``` -Optional options: +### Optional options -- Listen address (one of): - * `[host]:port`: Address and port (default: `localhost:4401`) - * `unix:/path.sock`: Unix socket -- `--rp-id `: Main domain (required for production) -- `--rp-name ""`: Name of your company or site (default: same as rp-id) -- `--origin `: Explicit single site (default: `https://`) -- `--auth-host `: Dedicated authentication site (e.g., `auth.example.com`) +| Option | Description | Default | +|--------|-------------|---------| +| Listen address | One of **[host]:port** (address and port) or **unix:/path.sock** (Unix socket) | **localhost:4401** | +| --rp-id ** | Main domain (required for production) | | +| --rp-name "**" | Name of your company or site | same as rp-id | +| --origin ** | Explicit single site | **https://**** | +| --auth-host ** | Dedicated authentication site (e.g., **auth.example.com**) | | ## Documentation -- `API.md`: Complete HTTP and WebSocket API reference -- `Caddy.md`: Caddy configuration examples -- `Headers.md`: HTTP headers passed to protected applications +- [API reference](https://git.zi.fi/LeoVasanko/paskia/src/branch/main/API.md) +- [Caddy configuration](https://git.zi.fi/LeoVasanko/paskia/src/branch/main/Caddy.md) +- [HTTP headers passed to your application](https://git.zi.fi/LeoVasanko/paskia/src/branch/main/Headers.md)