diff --git a/.env.example b/.env.example index fb3ccf8d..c702fcda 100644 --- a/.env.example +++ b/.env.example @@ -12,11 +12,14 @@ POSTGRES_DB=il_sdk POSTGRES_USER=il_sdk POSTGRES_PASSWORD=test -# things to adapt +# ---- Things to adapt ---- CLIENT_URL=... -AUTHORIZATION_SERVICE_URL=... AA_TOKEN=token -DATA_SERVICE_URL=... DOCUMENT_INDEX_URL=... +# needed for studio integration +DATA_SERVICE_URL=... +AUTHORIZATION_SERVICE_URL=... + +# needed for hugging face integration HUGGING_FACE_TOKEN=token diff --git a/CHANGELOG.md b/CHANGELOG.md index c513248c..7160f4f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,9 @@ ### Breaking Changes - The env variable `POSTGRES_HOST` is split into `POSTGRES_HOST` and `POSTGRES_PORT`. This affects all classes interacting with Studio and the `InstructionFinetuningDataRepository`. + - The following env variables now need to be set (previously pointed to defaults) + - `CLIENT_URL` - URL of your inference stack + - `DOCUMENT_INDEX_URL` - URL of the document index ## 8.0.0