From b786b94dbc347a396a3f8c27c33bc310d47c94dd Mon Sep 17 00:00:00 2001 From: kahghi Date: Wed, 22 Jan 2025 10:23:46 +0800 Subject: [PATCH] added more details and consolidated gcs and s3 under cloud storage --- .../advanced-topics/env-configuration.md | 24 +++++++++++++------ 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/advanced-topics/env-configuration.md b/docs/getting-started/advanced-topics/env-configuration.md index 46a9a9e..471ea06 100644 --- a/docs/getting-started/advanced-topics/env-configuration.md +++ b/docs/getting-started/advanced-topics/env-configuration.md @@ -1935,14 +1935,20 @@ See https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-registe These variables are not specific to Open WebUI but can still be valuable in certain contexts. -### Amazon S3 Storage +### Cloud Storage #### `STORAGE_PROVIDER` - Type: `str` +- Options: + - `s3` - uses S3 client library and related environment variables mentioned in [Amazon S3 Storage](#amazon-s3-storage) + - `gcs` - uses GCS client library and related environment variables mentioned in [Google Cloud Storage](#google-cloud-storage) + - Default: empty string (' '), which defaults to `local` - Description: Sets the storage provider. +#### Amazon S3 Storage + #### `S3_ACCESS_KEY_ID` - Type: `str` @@ -1968,16 +1974,20 @@ These variables are not specific to Open WebUI but can still be valuable in cert - Type: `str` - Description: Sets the secret access key for S3 storage. -### Google Cloud Storage -#### `GCS_BUCKET_NAME` - -- Type: `str` -- Description: Sets the bucket name for Google Cloud Storage +#### Google Cloud Storage #### `GOOGLE_APPLICATION_CREDENTIALS_JSON` -- Type: `JSON` +- Type: `str` - Description: Contents of Google Application Credentials JSON file. + - Optional - if not provided, credentials will be taken from the environment. User credentials if run locally and Google Metadata server if run on a Google Compute Engine. + - File can be generated for a service account following this [guide](https://developers.google.com/workspace/guides/create-credentials#service-account) + + +#### `GCS_BUCKET_NAME` + +- Type: `str` +- Description: Sets the bucket name for Google Cloud Storage. Bucket must already exist. ### Database Pool