Skip to content

Commit 433b887

Browse files
committed
chore(docs): cleanup configuration
1 parent 2931caf commit 433b887

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,28 +53,23 @@ uvicorn --factory stac_auth_proxy:create_app
5353

5454
The application is configurable via environment variables.
5555

56-
- `UPSTREAM_URL`
57-
- The STAC API to proxy requests to
56+
- `UPSTREAM_URL`, STAC API URL
5857
- **Type:** HTTP(S) URL
5958
- **Required:** Yes
6059
- **Example:** `https://your-stac-api.com/stac`
61-
- `OIDC_DISCOVERY_URL`
62-
- OpenID Connect discovery document URL
60+
- `OIDC_DISCOVERY_URL`, OpenID Connect discovery document URL
6361
- **Type:** HTTP(S) URL
6462
- **Required:** Yes
6563
- **Example:** `https://auth.example.com/.well-known/openid-configuration`
66-
- `OIDC_DISCOVERY_INTERNAL_URL`
67-
- The internal network OpenID Connect discovery document URL
64+
- `OIDC_DISCOVERY_INTERNAL_URL`, internal network OpenID Connect discovery document URL
6865
- **Type:** HTTP(S) URL
6966
- **Required:** No, defaults to the value of `OIDC_DISCOVERY_URL`
7067
- **Example:** `http://auth/.well-known/openid-configuration`
71-
- `DEFAULT_PUBLIC`
72-
- **Description:** Default access policy for endpoints
68+
- `DEFAULT_PUBLIC`, default access policy for endpoints
7369
- **Type:** boolean
7470
- **Required:** No, defaults to `false`
7571
- **Example:** `false`, `1`, `True`
76-
- `PRIVATE_ENDPOINTS`
77-
- **Description:** Endpoints explicitly marked as requiring authentication, used when `DEFAULT_PUBLIC == True`
72+
- `PRIVATE_ENDPOINTS`, endpoints explicitly marked as requiring authentication, used when `DEFAULT_PUBLIC == True`
7873
- **Type:** JSON object mapping regex patterns to HTTP methods OR tuples of HTTP methods and an array of strings representing required scopes
7974
- **Required:** No, defaults to the following:
8075
```json
@@ -86,8 +81,7 @@ The application is configurable via environment variables.
8681
"^/collections/([^/]+)/bulk_items$": ["POST"]
8782
}
8883
```
89-
- `PUBLIC_ENDPOINTS`
90-
- **Description:** Endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
84+
- `PUBLIC_ENDPOINTS`, endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
9185
- **Type:** JSON object mapping regex patterns to HTTP methods
9286
- **Required:** No, defaults to the following:
9387
```json
@@ -96,16 +90,14 @@ The application is configurable via environment variables.
9690
"^/api$": ["GET"]
9791
}
9892
```
99-
- `OPENAPI_SPEC_ENDPOINT`
100-
- Path to serve OpenAPI specification
93+
- `OPENAPI_SPEC_ENDPOINT`, path to serve OpenAPI specification
10194
- **Type:** string or null
10295
- **Required:** No, defaults to `null` (disabled)
10396
- **Example:** `/api`
104-
- `ITEMS_FILTER`
105-
- Configuration for item-level filtering
97+
- `ITEMS_FILTER`, configuration for item-level filtering
10698
- **Type:** JSON object with class configuration
10799
- **Required:** No, defaults to `null` (disabled)
108-
- Components:
100+
- **Components**:
109101
- `cls`: Python import path
110102
- `args`: List of positional arguments
111103
- `kwargs`: Dictionary of keyword arguments

0 commit comments

Comments
 (0)