From 5fad72983980d3fcaababb43c1778d8209693f95 Mon Sep 17 00:00:00 2001 From: Leo Vasanko Date: Fri, 19 Dec 2025 20:56:47 +0000 Subject: [PATCH] Docs updates. --- Headers.md | 8 ++++---- README.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Headers.md b/Headers.md index 1e79f22..c68288d 100644 --- a/Headers.md +++ b/Headers.md @@ -5,11 +5,11 @@ | `Remote-User` | Authenticated user UUID | **01c03276-b8f0-**… (string) | | `Remote-Name` | User display name | **John Doe** | | `Remote-Org` | Organization UUID | Identifier for user's org (string) | -| `Remote-Org-Name` | Organization display name | `The Company Ltd.` | +| `Remote-Org-Name` | Organization display name | **The Company Ltd.** | | `Remote-Role` | Role UUID | Identifier for user's role (string) | -| `Remote-Role-Name` | Role display name | `Employee` | -| `Remote-Groups` | Permissions the user has, comma separated | `auth:admin,yourapp:reports` | -| `Remote-Session-Expires` | Session expiry timestamp (ISO 8601 UTC) | `2030-12-31T23:59:59Z` | +| `Remote-Role-Name` | Role display name | **Employee** | +| `Remote-Groups` | Permissions the user has, comma separated | **auth:admin,yourapp:reports** | +| `Remote-Session-Expires` | Session expiry timestamp (ISO 8601 UTC) | **2030-12-31T23:59:59Z** | | `Remote-Credential` | Credential UUID | Identifier for the sign-in passkey (string) | Similar headers are also used by other authentication systems like [Authelia](https://www.authelia.com/integration/trusted-header-sso/introduction/) to signal the backend application information about the signed in user. diff --git a/README.md b/README.md index 408d072..e272a69 100644 --- a/README.md +++ b/README.md @@ -53,10 +53,10 @@ paskia serve [options] | Option | Description | Default | |--------|-------------|---------| | Listen address | One of **:** (default all hosts, port 4401) or **unix:/path/to/paskia.socket** (Unix socket) | **localhost:4401** | -| --rp-id ** | Main/top domain | **localhost** | -| --rp-name "**" | Name of your company or site | Same as rp-id | -| --origin ** | Explicitly list the domain names served () | **https://rp-id** | -| --auth-host ** | Dedicated authentication site (e.g., **auth.example.com**) | Unspecified: we use **/auth/** on *every* site under rp-id.| +| --rp-id **** | Main/top domain | **localhost** | +| --rp-name **** | Name of your company or site | Same as rp-id | +| --origin **url>** | Explicitly list the domain names served () | **https://rp-id** | +| --auth-host **** | Dedicated authentication site (e.g., **auth.example.com**) | Unspecified: we use **/auth/** on *every* site under rp-id.| ## Further Documentation