Skip to content

Commit 2565238

Browse files
giftkugelgiftkugel
committed
Update documentation
1 parent a16189c commit 2565238

File tree

1 file changed

+53
-38
lines changed

1 file changed

+53
-38
lines changed

‎website/docs/introduction/config.md‎

Lines changed: 53 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ Root entry named `server`
3131
| Property | Description | Required |
3232
|-------------------------------|---------------------------------------------------------------------------------------------------|----------|
3333
| `logLevel` | Log level | No |
34-
| [`cookies`](#cookies) | Configuration related to cookie names | No |
3534
| `addr` | [Go like address](https://pkg.go.dev/net#Dial), may contain IP and port | Yes |
35+
| [`cookies`](#cookies) | Configuration related to cookie names | No |
3636
| `secret` | Server secret | No |
3737
| `privateKey` | General RSA or EC private key (can be overwritten for each client) to sign tokens | No |
38-
| `issuer` | Issuer | No |
3938
| [`tls`](#tls) | Configuration for TLS | No |
4039
| `logoutRedirect` | Where to redirect user after logout | No |
4140
| `introspectScope` | Scope which allows token introspection | No |
4241
| `revokeScopeScope` | Scope which allows token revocation | No |
4342
| `sessionTimeoutSeconds` | Seconds until session will end | No |
43+
| `issuer` | Issuer | No |
4444
| [`forwardAuth`](#forwardauth) | [Traefik ForwardAuth](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) configuration | No |
4545

4646
#### TLS
@@ -49,10 +49,10 @@ Public and private keys to sign tokens
4949

5050
Entry `server.tls`
5151

52-
| Property | Description | Required |
53-
|----------|-------------------------------------------------------------------------|----------|
54-
| `addr` | [Go like address](https://pkg.go.dev/net#Dial), may contain IP and port | Yes |
55-
| `keys` | Public and private keys for TLS | Yes |
52+
| Property | Description | Required |
53+
|---------------------|-------------------------------------------------------------------------|----------|
54+
| `addr` | [Go like address](https://pkg.go.dev/net#Dial), may contain IP and port | Yes |
55+
| [`keys`](#tls-keys) | Public and private keys for TLS | Yes |
5656

5757
##### TLS keys
5858

@@ -71,10 +71,11 @@ Public and private keys to sign tokens
7171

7272
Entry `server.cookies`
7373

74-
| Property | Description | Required |
75-
|---------------|----------------------------------|----------|
76-
| `authName` | Name of the authorization cookie | No |
77-
| `messageName` | Name of internal message cookie | No |
74+
| Property | Description | Required |
75+
|-------------------|-----------------------------------------------------|----------|
76+
| `authName` | Name of the authorization cookie | No |
77+
| `messageName` | Name of internal message cookie | No |
78+
| `forwardAuthName` | Name of internal [ForwardAuth](#forwardauth) cookie | No |
7879

7980
#### ForwardAuth
8081

@@ -93,14 +94,16 @@ Entry `server.forwardAuth`
9394

9495
Root entry named `ui`
9596

96-
| Property | Description | Required |
97-
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------|
98-
| `logoImage` | Path of additional logo image | No |
99-
| `hideFooter` | Will hide the **STOPnik** footer | No |
100-
| `hideMascot` | Will hide the **STOPnik** mascot | No |
101-
| `footerText` | The footer text | No |
102-
| `title` | Title displayed above the forms | No |
103-
| `htmlTitle` | HTML title | No |
97+
| Property | Description | Required |
98+
|-----------------------------|-----------------------------------------|----------|
99+
| `hideFooter` | Will hide the **STOPnik** footer | No |
100+
| `hideLogo` | Will hide the **STOPnik** logo | No |
101+
| `htmlTitle` | HTML page title | No |
102+
| `title` | Title displayed above the forms | No |
103+
| `footerText` | The footer text | No |
104+
| `logoImage` | Path of additional logo image | No |
105+
| `invalidCredentialsMessage` | Message to show for invalid credentials | No |
106+
| `expiredLoginMessage` | Message to show when login expired | No |
104107

105108
### Clients
106109

@@ -115,10 +118,10 @@ Each entry may contain the following options
115118
| `id` | The id of the client | Yes |
116119
| `clientSecret` | SHA512 hashed secret | No |
117120
| `salt` | Optional salt for secret to avoid identical hash values | No |
121+
| `oidc` | Flag to allow an client to handle OpenId Connect | No |
118122
| `accessTTL` | Access token time to live | No |
119123
| `refreshTTL` | Refresh token time to live | No |
120124
| `idTTL` | OpenId Connect ID token time to live | No |
121-
| `oidc` | Flag to allow an client to handle OpenId Connect | No |
122125
| `introspect` | Introspection scope | No |
123126
| `revoke` | Revocation scope | No |
124127
| `redirects` | List of redirects URIs | No |
@@ -139,47 +142,59 @@ Root entry `users`
139142

140143
Each entry may contain the following options
141144

142-
| Property | Description | Required |
143-
|----------------------------|--------------------------------------------------------------------|----------|
144-
| `username` | Username | Yes |
145-
| `password` | SHA512 hashed password | Yes |
146-
| `salt` | Optional salt for password to avoid identical hash values | No |
147-
| [`profile`](#user-profile) | User profile which will be used for OpenId Connect UserInfo | No |
145+
| Property | Description | Required |
146+
|----------------------------------------|-----------------------------------------------------------------|----------|
147+
| `username` | Username | Yes |
148+
| `password` | SHA512 hashed password | Yes |
149+
| `salt` | Optional salt for password to avoid identical hash values | No |
150+
| [`userProfile`](#user-profile) | User profile which will be used for OpenId Connect UserInfo | No |
151+
| [`userInformation`](#user-information) | User information which will be used for OpenId Connect UserInfo | No |
148152

149153
For `password` and `salt` see, [Command line - Password](../advanced/cmd.md#password)
150154

151155
#### User profile
152156

153157
User profile which will be used for OpenId Connect UserInfo
154158

155-
Entry `users[n].profile`
159+
Entry `users[n].userProfile`
160+
161+
Each entry may contain the following options
162+
163+
| Property | Description | Required |
164+
|---------------------|---------------------|----------|
165+
| `givenName` | Given name | No |
166+
| `familyName` | Family name | No |
167+
| `nickname` | Nickname | No |
168+
| `preferredUserName` | Preferred username | No |
169+
| `gender` | Gender | No |
170+
| `birthDate` | Birthdate | No |
171+
| `zoneInfo` | Zone information | No |
172+
| `locale` | locale | No |
173+
| `website` | Website URL | No |
174+
| `profile` | Profile URL | No |
175+
| `picture` | Profile picture URL | No |
176+
177+
#### User information
178+
179+
User information which will be used for OpenId Connect UserInfo
180+
181+
Entry `users[n].userInformation`
156182

157183
Each entry may contain the following options
158184

159185
| Property | Description | Required |
160186
|----------------------------|----------------------------------|----------|
161-
| `givenName` | Given name | No |
162-
| `familyName` | Family name | No |
163-
| `nickname` | Nickname | No |
164-
| `preferredUserName` | Preferred username | No |
165187
| `email` | E-Mail address | No |
166188
| `emailVerified` | E-Mail address verification flag | No |
167-
| `gender` | Gender | No |
168-
| `birthDate` | Birthdate | No |
169-
| `zoneInfo` | Zone information | No |
170-
| `locale` | locale | No |
171189
| `phoneNumber` | Phone number | No |
172190
| `phoneVerified` | Phone number verification flag | No |
173-
| `website` | Website URL | No |
174-
| `profile` | Profile URL | No |
175-
| `profilePicture` | Profile picture URL | No |
176191
| [`address`](#user-address) | User address | No |
177192

178193
#### User address
179194

180195
User address which will be used for OpenId Connect UserInfo
181196

182-
Entry `users[n].profile.address`
197+
Entry `users[n].userInformation.address`
183198

184199
Each entry may contain the following options
185200

0 commit comments

Comments
 (0)