@@ -53,28 +53,23 @@ uvicorn --factory stac_auth_proxy:create_app
53
53
54
54
The application is configurable via environment variables.
55
55
56
- - ` UPSTREAM_URL `
57
- - The STAC API to proxy requests to
56
+ - ` UPSTREAM_URL ` , STAC API URL
58
57
- ** Type:** HTTP(S) URL
59
58
- ** Required:** Yes
60
59
- ** 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
63
61
- ** Type:** HTTP(S) URL
64
62
- ** Required:** Yes
65
63
- ** 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
68
65
- ** Type:** HTTP(S) URL
69
66
- ** Required:** No, defaults to the value of ` OIDC_DISCOVERY_URL `
70
67
- ** 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
73
69
- ** Type:** boolean
74
70
- ** Required:** No, defaults to ` false `
75
71
- ** 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 `
78
73
- ** Type:** JSON object mapping regex patterns to HTTP methods OR tuples of HTTP methods and an array of strings representing required scopes
79
74
- ** Required:** No, defaults to the following:
80
75
``` json
@@ -86,8 +81,7 @@ The application is configurable via environment variables.
86
81
"^/collections/([^/]+)/bulk_items$" : [" POST" ]
87
82
}
88
83
```
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`
91
85
- **Type:** JSON object mapping regex patterns to HTTP methods
92
86
- **Required:** No, defaults to the following:
93
87
```json
@@ -96,16 +90,14 @@ The application is configurable via environment variables.
96
90
"^/api$" : [" GET" ]
97
91
}
98
92
```
99
- - `OPENAPI_SPEC_ENDPOINT`
100
- - Path to serve OpenAPI specification
93
+ - `OPENAPI_SPEC_ENDPOINT`, path to serve OpenAPI specification
101
94
- **Type:** string or null
102
95
- **Required:** No, defaults to `null` (disabled)
103
96
- **Example:** `/api`
104
- - `ITEMS_FILTER`
105
- - Configuration for item-level filtering
97
+ - `ITEMS_FILTER`, configuration for item-level filtering
106
98
- **Type:** JSON object with class configuration
107
99
- **Required:** No, defaults to `null` (disabled)
108
- - Components:
100
+ - ** Components** :
109
101
- `cls`: Python import path
110
102
- `args`: List of positional arguments
111
103
- `kwargs`: Dictionary of keyword arguments
0 commit comments