Skip to content

Commit

Permalink
Update configuration.md
Browse files Browse the repository at this point in the history
Signed-off-by: Panos Vagenas <[email protected]>
  • Loading branch information
vagenas authored Jul 27, 2023
1 parent addf4de commit cd02cd3
Showing 1 changed file with 3 additions and 22 deletions.
25 changes: 3 additions & 22 deletions docs/guide/configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuration
e# Configuration

The Toolkit can be configured via the CLI and via environment variables.

Expand Down Expand Up @@ -111,26 +111,7 @@ Besides allowing the Toolkit to easily persist and manage config options (e.g. a
above for profiles), this also means that configuration can be easily overriden via
environment variables.

To see which environment variables are supported, check the Pydantic Settings files below,
taking into account the defined prefixes:

| File | Description |
| --- | --- |
| [Core settings][settings_file] | Global and profile-level settings |
| [Model App settings][model_api_settings] | Settings for Model API App |

For example:

- `DEEPSEARCH_PROFILE`: controls profile for scope of single operation, e.g.
`DEEPSEARCH_PROFILE=bar deepsearch cps projects list`
- `DEEPSEARCH_SHOW_STACKTRACE`: controls if stacktraces are printed, e.g.
`DEEPSEARCH_SHOW_STACKTRACE=1 deepsearch profile show inexistent`


!!! note

When extending the settings (e.g. like in [Model API][model_api_settings]), developers
must properly set `env_prefix` to prevent conflicts.
To see which environment variables are supported, check the relevant [Pydantic Settings
classes][settings_file], also taking into account any defined prefixes.

[settings_file]: https://github.com/DS4SD/deepsearch-toolkit/blob/main/deepsearch/core/client/settings.py
[model_api_settings]: https://github.com/DS4SD/deepsearch-toolkit/blob/main/deepsearch/model/server/config.py

0 comments on commit cd02cd3

Please sign in to comment.