Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add table for environment variables in README.SATOSA.md #323

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.SATOSA.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,16 @@ Configure an httpd fronted such NginX, an example is available within the `uwsgi
remember to customize and add any additional parameter to your preferred httpd configuration.


## Environment Variables Configuration
SATOSA supports the following environment variables to customize its behavior:
| **Variable Name** | **Description** | **Default Value** | **Allowed Values** | **Context** |
| -------------------------------- | -------------------------------------------------------------------------------- | ------------------- | -------------------------- | ------------------------- |
| `PYEUDIW_MONGO_TEST_AUTH_INLINE` | MongoDB connection string used for SATOSA integration tests. | `""` (empty string) | Valid MongoDB URI | Integration Testing |
| `PYEUDIW_LRU_CACHE_MAXSIZE` | Configures the maximum number of elements to store in the Least Recently Used (LRU) cache. | `2048` | Integer | Cache Management |
| `PYEUDIW_HTTPC_SSL` | Enables or disables SSL verification for HTTP client requests. | `True` | `True`, `False` | HTTP Client Configuration |
| `PYEUDIW_HTTPC_TIMEOUT` | Sets the timeout for HTTP client requests. | `6` seconds | Integer | HTTP Client Configuration |
| `SD_JWT_HEADER` | Specifies the type of SD-JWT header to use when generating or verifying SD-JWTs. | `dc+sd-jwt` | Custom values as per usage | SD-JWT Configuration |

### Notes:
1. These variables are optional and, if not explicitly set, default values will be used.
2. To define these variables, you can use export commands in shell scripts, or any environment variable management tool.
7 changes: 1 addition & 6 deletions docs/TRUST.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,7 @@ HTTPC parameters are optional and described below.
| httpc_params.connection | dictionary that represents a `aiohttp._RequestOptions` used in GET requests |
| httpc_params.session | dictionary that represents the keyword arguments of `aiohttp.ClientSession` |

Some HTTPC parameters are commonly used, have a default value and as an alternative can be optionally defined by an environment variable.

| Parameter | Description | Default Value | Environment Variable |
| ---------------------------- | --------------------------------------------------------------- | ------------- | --------------------- |
| httpc_params.connection.ssl | The flag to indicate whether to use SSL for the HTTP connection | true | PYEUDIW_HTTPC_SSL |
| httpc_params.session.timeout | The timeout value for the HTTP session | 6 | PYEUDIW_HTTPC_TIMEOUT |
Some HTTPC parameters are commonly used, have a default value and as an alternative can be optionally defined by an [environment variable](https://github.com/italia/eudi-wallet-it-python/blob/dev/README.SATOSA.md).

### Federation

Expand Down
2 changes: 1 addition & 1 deletion pyeudiw/tools/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ def cacheable_get_http_url(cache_ttl: int, url: str, httpc_params: dict, http_as
return resp


@lru_cache(os.getenv("PYEUDIW_LRU_CACHE_TTL", 2048))
@lru_cache(os.getenv("PYEUDIW_LRU_CACHE_MAXSIZE", 2048))
def _lru_cached_get_http_url(timestamp: int, url: str, httpc_params_tuple: _HttpcParams_T, http_async: bool = True) -> requests.Response:
"""
Wraps method 'get_http_url' around a ttl cache.
Expand Down
Loading