Skip to content

Commit bdf9405

Browse files
alukachalukach
committed
docs(user-guide): formatting
1 parent 6718991 commit bdf9405

File tree

1 file changed

+56
-57
lines changed

1 file changed

+56
-57
lines changed

‎docs/user-guide/configuration.md

Lines changed: 56 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -8,57 +8,57 @@ The application is configurable via environment variables.
88

99
: STAC API URL
1010

11-
**Type:** HTTP(S) URL
12-
**Required:** Yes
11+
**Type:** HTTP(S) URL
12+
**Required:** Yes
1313
**Example:** `https://your-stac-api.com/stac`
1414

1515
### `WAIT_FOR_UPSTREAM`
1616

1717
: Wait for upstream API to become available before starting proxy
1818

19-
**Type:** boolean
20-
**Required:** No, defaults to `true`
19+
**Type:** boolean
20+
**Required:** No, defaults to `true`
2121
**Example:** `false`, `1`, `True`
2222

2323
### `CHECK_CONFORMANCE`
2424

2525
: Ensure upstream API conforms to required conformance classes before starting proxy
2626

27-
**Type:** boolean
28-
**Required:** No, defaults to `true`
27+
**Type:** boolean
28+
**Required:** No, defaults to `true`
2929
**Example:** `false`, `1`, `True`
3030

3131
### `ENABLE_COMPRESSION`
3232

3333
: Enable response compression
3434

35-
**Type:** boolean
36-
**Required:** No, defaults to `true`
35+
**Type:** boolean
36+
**Required:** No, defaults to `true`
3737
**Example:** `false`, `1`, `True`
3838

3939
### `HEALTHZ_PREFIX`
4040

4141
: Path prefix for health check endpoints
4242

43-
**Type:** string
44-
**Required:** No, defaults to `/healthz`
43+
**Type:** string
44+
**Required:** No, defaults to `/healthz`
4545
**Example:** `''` (disabled)
4646

4747
### `OVERRIDE_HOST`
4848

4949
: Override the host header for the upstream API
5050

51-
**Type:** boolean
52-
**Required:** No, defaults to `true`
51+
**Type:** boolean
52+
**Required:** No, defaults to `true`
5353
**Example:** `false`, `1`, `True`
5454

5555
### `ROOT_PATH`
5656

5757
: Path prefix for the proxy API
5858

59-
**Type:** string
60-
**Required:** No, defaults to `''` (root path)
61-
**Example:** `/api/v1`
59+
**Type:** string
60+
**Required:** No, defaults to `''` (root path)
61+
**Example:** `/api/v1`
6262
**Note:** This is independent of the upstream API's path. The proxy will handle removing this prefix from incoming requests and adding it to outgoing links.
6363

6464
## Authentication
@@ -67,41 +67,40 @@ The application is configurable via environment variables.
6767

6868
: OpenID Connect discovery document URL
6969

70-
**Type:** HTTP(S) URL
71-
**Required:** Yes
70+
**Type:** HTTP(S) URL
71+
**Required:** Yes
7272
**Example:** `https://auth.example.com/.well-known/openid-configuration`
7373

7474
### `OIDC_DISCOVERY_INTERNAL_URL`
7575

7676
: Internal network OpenID Connect discovery document URL
7777

78-
**Type:** HTTP(S) URL
79-
**Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`
78+
**Type:** HTTP(S) URL
79+
**Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`
8080
**Example:** `http://auth/.well-known/openid-configuration`
8181

82-
### `ALLOWED_JWT_AUDIENCES`
82+
### `ALLOWED_JWT_AUDIENCES`
8383

8484
: Unique identifier(s) of API resource server(s)
8585

86-
**Type:** string
87-
**Required:** No
86+
**Type:** string
87+
**Required:** No
8888
**Example:** `https://auth.example.audience.1.net,https://auth.example.audience.2.net`
89-
**Note** A comma-separated list of the intended recipient(s) of the JWT. At least one audience value must match the `aud` (audience) claim present in the incoming JWT. If undefined, the API will not impose a check on the `aud` claim
90-
89+
**Note:** A comma-separated list of the intended recipient(s) of the JWT. At least one audience value must match the `aud` (audience) claim present in the incoming JWT. If undefined, the API will not impose a check on the `aud` claim
9190

9291
### `DEFAULT_PUBLIC`
9392

9493
: Default access policy for endpoints
9594

96-
**Type:** boolean
97-
**Required:** No, defaults to `false`
95+
**Type:** boolean
96+
**Required:** No, defaults to `false`
9897
**Example:** `false`, `1`, `True`
9998

10099
### `PRIVATE_ENDPOINTS`
101100

102101
: Endpoints explicitly marked as requiring authentication and possibly scopes
103102

104-
**Type:** JSON object mapping regex patterns to HTTP methods OR tuples of an HTTP method and string representing required scopes
103+
**Type:** JSON object mapping regex patterns to HTTP methods OR tuples of an HTTP method and string representing required scopes
105104
**Required:** No, defaults to the following:
106105
```json
107106
{
@@ -117,7 +116,7 @@ The application is configurable via environment variables.
117116

118117
: Endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
119118

120-
**Type:** JSON object mapping regex patterns to HTTP methods
119+
**Type:** JSON object mapping regex patterns to HTTP methods
121120
**Required:** No, defaults to the following:
122121
```json
123122
{
@@ -134,8 +133,8 @@ The application is configurable via environment variables.
134133

135134
: Enable authentication extension in STAC API responses
136135

137-
**Type:** boolean
138-
**Required:** No, defaults to `true`
136+
**Type:** boolean
137+
**Required:** No, defaults to `true`
139138
**Example:** `false`, `1`, `True`
140139

141140
## OpenAPI / Swagger UI
@@ -152,22 +151,22 @@ The application is configurable via environment variables.
152151

153152
: Name of the auth scheme to use in the OpenAPI spec
154153

155-
**Type:** string
156-
**Required:** No, defaults to `oidcAuth`
154+
**Type:** string
155+
**Required:** No, defaults to `oidcAuth`
157156
**Example:** `jwtAuth`
158157

159158
### `OPENAPI_AUTH_SCHEME_OVERRIDE`
160159

161160
: Override for the auth scheme in the OpenAPI spec
162161

163-
**Type:** JSON object
164-
**Required:** No, defaults to `null` (disabled)
165-
**Example:**
162+
**Type:** JSON object
163+
**Required:** No, defaults to `null` (disabled)
164+
**Example:**
166165
```json
167166
{
168-
"type": "http",
169-
"scheme": "bearer",
170-
"bearerFormat": "JWT",
167+
"type": "http",
168+
"scheme": "bearer",
169+
"bearerFormat": "JWT",
171170
"description": "Paste your raw JWT here. This API uses Bearer token authorization.\n"
172171
}
173172
```
@@ -184,8 +183,8 @@ The application is configurable via environment variables.
184183

185184
: Initialization options for the [Swagger UI OAuth2 configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/) on custom Swagger UI
186185

187-
**Type:** JSON object
188-
**Required:** No, defaults to `null` (disabled)
186+
**Type:** JSON object
187+
**Required:** No, defaults to `null` (disabled)
189188
**Example:** `{"clientId": "stac-auth-proxy", "usePkceWithAuthorizationCodeGrant": true}`
190189

191190
## Filtering
@@ -194,62 +193,62 @@ The application is configurable via environment variables.
194193

195194
: CQL2 expression generator for item-level filtering
196195

197-
**Type:** JSON object with class configuration
198-
**Required:** No, defaults to `null` (disabled)
196+
**Type:** JSON object with class configuration
197+
**Required:** No, defaults to `null` (disabled)
199198
**Example:** `stac_auth_proxy.filters:Opa`, `stac_auth_proxy.filters:Template`, `my_package:OrganizationFilter`
200199

201200
### `ITEMS_FILTER_ARGS`
202201

203202
: Positional arguments for CQL2 expression generator
204203

205-
**Type:** List of positional arguments used to initialize the class
206-
**Required:** No, defaults to `[]`
204+
**Type:** List of positional arguments used to initialize the class
205+
**Required:** No, defaults to `[]`
207206
**Example:** `["org1"]`
208207

209208
### `ITEMS_FILTER_KWARGS`
210209

211210
: Keyword arguments for CQL2 expression generator
212211

213-
**Type:** Dictionary of keyword arguments used to initialize the class
214-
**Required:** No, defaults to `{}`
212+
**Type:** Dictionary of keyword arguments used to initialize the class
213+
**Required:** No, defaults to `{}`
215214
**Example:** `{"field_name": "properties.organization"}`
216215

217216
### `ITEMS_FILTER_PATH`
218217

219218
: Regex pattern used to identify request paths that require the application of the items filter
220219

221-
**Type:** Regex string
222-
**Required:** No, defaults to `^(/collections/([^/]+)/items(/[^/]+)?$|/search$)`
220+
**Type:** Regex string
221+
**Required:** No, defaults to `^(/collections/([^/]+)/items(/[^/]+)?$|/search$)`
223222
**Example:** `^(/collections/([^/]+)/items(/[^/]+)?$|/search$|/custom$)`
224223

225224
### `COLLECTIONS_FILTER_CLS`
226225

227226
: CQL2 expression generator for collection-level filtering
228227

229-
**Type:** JSON object with class configuration
230-
**Required:** No, defaults to `null` (disabled)
228+
**Type:** JSON object with class configuration
229+
**Required:** No, defaults to `null` (disabled)
231230
**Example:** `stac_auth_proxy.filters:Opa`, `stac_auth_proxy.filters:Template`, `my_package:OrganizationFilter`
232231

233232
### `COLLECTIONS_FILTER_ARGS`
234233

235234
: Positional arguments for CQL2 expression generator
236235

237-
**Type:** List of positional arguments used to initialize the class
238-
**Required:** No, defaults to `[]`
236+
**Type:** List of positional arguments used to initialize the class
237+
**Required:** No, defaults to `[]`
239238
**Example:** `["org1"]`
240239

241240
### `COLLECTIONS_FILTER_KWARGS`
242241

243242
: Keyword arguments for CQL2 expression generator
244243

245-
**Type:** Dictionary of keyword arguments used to initialize the class
246-
**Required:** No, defaults to `{}`
244+
**Type:** Dictionary of keyword arguments used to initialize the class
245+
**Required:** No, defaults to `{}`
247246
**Example:** `{"field_name": "properties.organization"}`
248247

249248
### `COLLECTIONS_FILTER_PATH`
250249

251250
: Regex pattern used to identify request paths that require the application of the collections filter
252251

253-
**Type:** Regex string
254-
**Required:** No, defaults to `^/collections(/[^/]+)?$`
255-
**Example:** `^.*?/collections(/[^/]+)?$`
252+
**Type:** Regex string
253+
**Required:** No, defaults to `^/collections(/[^/]+)?$`
254+
**Example:** `^.*?/collections(/[^/]+)?$`

0 commit comments

Comments
 (0)