README formatting and links.
This commit is contained in:
@@ -55,18 +55,18 @@ There is no config file. Pass only the options on CLI:
|
|||||||
paskia serve [options]
|
paskia serve [options]
|
||||||
```
|
```
|
||||||
|
|
||||||
Optional options:
|
### Optional options
|
||||||
|
|
||||||
- Listen address (one of):
|
| Option | Description | Default |
|
||||||
* `[host]:port`: Address and port (default: `localhost:4401`)
|
|--------|-------------|---------|
|
||||||
* `unix:/path.sock`: Unix socket
|
| Listen address | One of **[host]:port** (address and port) or **unix:/path.sock** (Unix socket) | **localhost:4401** |
|
||||||
- `--rp-id <domain>`: Main domain (required for production)
|
| --rp-id *<domain>* | Main domain (required for production) | |
|
||||||
- `--rp-name "<text>"`: Name of your company or site (default: same as rp-id)
|
| --rp-name "*<text>*" | Name of your company or site | same as rp-id |
|
||||||
- `--origin <url>`: Explicit single site (default: `https://<rp-id>`)
|
| --origin *<url>* | Explicit single site | **https://*<rp-id>*** |
|
||||||
- `--auth-host <domain>`: Dedicated authentication site (e.g., `auth.example.com`)
|
| --auth-host *<domain>* | Dedicated authentication site (e.g., **auth.example.com**) | |
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- `API.md`: Complete HTTP and WebSocket API reference
|
- [API reference](https://git.zi.fi/LeoVasanko/paskia/src/branch/main/API.md)
|
||||||
- `Caddy.md`: Caddy configuration examples
|
- [Caddy configuration](https://git.zi.fi/LeoVasanko/paskia/src/branch/main/Caddy.md)
|
||||||
- `Headers.md`: HTTP headers passed to protected applications
|
- [HTTP headers passed to your application](https://git.zi.fi/LeoVasanko/paskia/src/branch/main/Headers.md)
|
||||||
|
|||||||
Reference in New Issue
Block a user