Skip to content

Commit 3996c3c

Browse files
mgilhamJoshMcCullough
authored andcommitted
fix spacing in README.md
1 parent 989aa82 commit 3996c3c

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ This module depends on the [JWT C Library](https://github.com/benmcollins/libjwt
1414

1515
This module requires several new `nginx.conf` directives, which can be specified at the `http`, `server`, or `location` levels.
1616

17-
| Directive | Description |
18-
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
19-
| `auth_jwt_key` | The key to use to decode/verify the JWT, *in binhex format* -- see below. |
20-
| `auth_jwt_redirect` | Set to "on" to redirect to `auth_jwt_loginurl` if authentication fails. |
21-
| `auth_jwt_loginurl` | The URL to redirect to if `auth_jwt_redirect` is enabled and authentication fails. |
22-
| `auth_jwt_enabled` | Set to "on" to enable JWT checking. |
23-
| `auth_jwt_algorithm` | The algorithm to use. One of: HS256, HS384, HS512, RS256, RS384, RS512 |
24-
| `auth_jwt_location` | Indicates where the JWT is located in the request -- see below. |
25-
| `auth_jwt_validate_sub` | Set to "on" to validate the `sub` claim (e.g. user id) in the JWT. |
26-
| `auth_jwt_extract_claims` | Set to a space-delimited list of claims to extract from the JWT and make available as NGINX variables. These will be accessible via e.g: `$jwt_claim_sub` |
27-
| `auth_jwt_extract_request_claims` | Set to a space-delimited list of claims to extract from the JWT and set as request headers. These will be accessible via e.g: `$http_jwt_sub` |
28-
| `auth_jwt_extract_response_claims` | Set to a space-delimited list of claims to extract from the JWT and set as response headers. These will be accessible via e.g: `$sent_http_jwt_sub` |
29-
| `auth_jwt_use_keyfile` | Set to "on" to read the key from a file rather than from the `auth_jwt_key` directive. |
30-
| `auth_jwt_keyfile_path` | Set to the path from which the key should be read when `auth_jwt_use_keyfile` is enabled. |
17+
| Directive | Description |
18+
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
19+
| `auth_jwt_key` | The key to use to decode/verify the JWT, *in binhex format* -- see below. |
20+
| `auth_jwt_redirect` | Set to "on" to redirect to `auth_jwt_loginurl` if authentication fails. |
21+
| `auth_jwt_loginurl` | The URL to redirect to if `auth_jwt_redirect` is enabled and authentication fails. |
22+
| `auth_jwt_enabled` | Set to "on" to enable JWT checking. |
23+
| `auth_jwt_algorithm` | The algorithm to use. One of: HS256, HS384, HS512, RS256, RS384, RS512 |
24+
| `auth_jwt_location` | Indicates where the JWT is located in the request -- see below. |
25+
| `auth_jwt_validate_sub` | Set to "on" to validate the `sub` claim (e.g. user id) in the JWT. |
26+
| `auth_jwt_extract_claims` | Set to a space-delimited list of claims to extract from the JWT and make available as NGINX variables. These will be accessible via e.g: `$jwt_claim_sub` |
27+
| `auth_jwt_extract_request_claims` | Set to a space-delimited list of claims to extract from the JWT and set as request headers. These will be accessible via e.g: `$http_jwt_sub` |
28+
| `auth_jwt_extract_response_claims` | Set to a space-delimited list of claims to extract from the JWT and set as response headers. These will be accessible via e.g: `$sent_http_jwt_sub` |
29+
| `auth_jwt_use_keyfile` | Set to "on" to read the key from a file rather than from the `auth_jwt_key` directive. |
30+
| `auth_jwt_keyfile_path` | Set to the path from which the key should be read when `auth_jwt_use_keyfile` is enabled. |
3131

3232

3333
## Algorithms

0 commit comments

Comments
 (0)