@@ -53,33 +53,33 @@ uvicorn --factory stac_auth_proxy:create_app
53
53
54
54
The application is configurable via environment variables.
55
55
56
- - ** Core**
57
- - ` UPSTREAM_URL ` , STAC API URL
56
+ - Core
57
+ - ** ` UPSTREAM_URL ` ** , STAC API URL
58
58
- ** Type:** HTTP(S) URL
59
59
- ** Required:** Yes
60
60
- ** Example:** ` https://your-stac-api.com/stac `
61
- - ` WAIT_FOR_UPSTREAM ` , wait for upstream API to become available before starting proxy
61
+ - ** ` WAIT_FOR_UPSTREAM ` ** , wait for upstream API to become available before starting proxy
62
62
- ** Type:** boolean
63
63
- ** Required:** No, defaults to ` true `
64
64
- ** Example:** ` false ` , ` 1 ` , ` True `
65
- - ` HEALTHZ_PREFIX ` , path prefix for health check endpoints
65
+ - ** ` HEALTHZ_PREFIX ` ** , path prefix for health check endpoints
66
66
- ** Type:** string
67
67
- ** Required:** No, defaults to ` /healthz `
68
68
- ** Example:** ` '' ` (disabled)
69
- - ** Authentication**
70
- - ` OIDC_DISCOVERY_URL ` , OpenID Connect discovery document URL
69
+ - Authentication
70
+ - ** ` OIDC_DISCOVERY_URL ` ** , OpenID Connect discovery document URL
71
71
- ** Type:** HTTP(S) URL
72
72
- ** Required:** Yes
73
73
- ** Example:** ` https://auth.example.com/.well-known/openid-configuration `
74
- - ` OIDC_DISCOVERY_INTERNAL_URL ` , internal network OpenID Connect discovery document URL
74
+ - ** ` OIDC_DISCOVERY_INTERNAL_URL ` ** , internal network OpenID Connect discovery document URL
75
75
- ** Type:** HTTP(S) URL
76
76
- ** Required:** No, defaults to the value of ` OIDC_DISCOVERY_URL `
77
77
- ** Example:** ` http://auth/.well-known/openid-configuration `
78
- - ` DEFAULT_PUBLIC ` , default access policy for endpoints
78
+ - ** ` DEFAULT_PUBLIC ` ** , default access policy for endpoints
79
79
- ** Type:** boolean
80
80
- ** Required:** No, defaults to ` false `
81
81
- ** Example:** ` false ` , ` 1 ` , ` True `
82
- - ` PRIVATE_ENDPOINTS ` , endpoints explicitly marked as requiring authentication, used when ` DEFAULT_PUBLIC == True `
82
+ - ** ` PRIVATE_ENDPOINTS ` ** , endpoints explicitly marked as requiring authentication, used when ` DEFAULT_PUBLIC == True `
83
83
- ** Type:** JSON object mapping regex patterns to HTTP methods OR tuples of HTTP methods and an array of strings representing required scopes
84
84
- ** Required:** No, defaults to the following:
85
85
``` json
@@ -91,7 +91,7 @@ The application is configurable via environment variables.
91
91
"^/collections/([^/]+)/bulk_items$" : [" POST" ]
92
92
}
93
93
```
94
- - `PUBLIC_ENDPOINTS`, endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
94
+ - ** `PUBLIC_ENDPOINTS`** , endpoints explicitly marked as not requiring authentication, used when `DEFAULT_PUBLIC == False`
95
95
- **Type:** JSON object mapping regex patterns to HTTP methods
96
96
- **Required:** No, defaults to the following:
97
97
```json
@@ -100,12 +100,12 @@ The application is configurable via environment variables.
100
100
"^/api$" : [" GET" ]
101
101
}
102
102
```
103
- - `OPENAPI_SPEC_ENDPOINT`, path of OpenAPI specification, used for augmenting spec response with auth configuration
103
+ - ** `OPENAPI_SPEC_ENDPOINT`** , path of OpenAPI specification, used for augmenting spec response with auth configuration
104
104
- **Type:** string or null
105
105
- **Required:** No, defaults to `null` (disabled)
106
106
- **Example:** `/api`
107
- - ** Filtering**
108
- - `ITEMS_FILTER`, [cql2 expression](https://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) generator for item-level filtering
107
+ - Filtering
108
+ - ** `ITEMS_FILTER`** , [cql2 expression](https://developmentseed.org/cql2-rs/latest/python/#cql2.Expr) generator for item-level filtering
109
109
- **Type:** JSON object with class configuration
110
110
- **Required:** No, defaults to `null` (disabled)
111
111
- **Components**:
0 commit comments