File Storage Configuration
Define where uploaded files and application data are stored.
The defaults here will work with no adjustments required if using the provided Docker Compose file.
General Storage Settings
| Environment Variable | Description | Type | Default Value |
|---|---|---|---|
FILE_CLOUD_PROVIDER | Which cloud provider to use for file storage. | azure, aws, google, s3-compatible | s3-compatible |
Azure Blob Storage
You can provide a connection string OR an account name + key.
| Environment Variable | Description | Type | Default Value |
|---|---|---|---|
AZURE_STORAGE_CONNECTION_STRING | Connection string for Azure Blob Storage. | string | null |
AZURE_STORAGE_ACCOUNT_NAME | Azure Storage account name. | string | null |
AZURE_STORAGE_ACCOUNT_KEY | Access key for Azure Storage account. | string | null |
AZURE_CONTAINER_NAME | Name of the Azure Blob Storage container. | string | null |
AWS S3
| Environment Variable | Description | Type | Default Value |
|---|---|---|---|
AWS_REGION | AWS region for the S3 bucket. | string | null |
AWS_ACCESS_KEY_ID | AWS Access Key ID for S3 access. | string | null |
AWS_SECRET_ACCESS_KEY | AWS Secret Access Key for S3 access. | string | null |
AWS_BUCKET_NAME | Name of the AWS S3 bucket. | string | null |
Google Cloud Storage (GCS)
There are two options for Google storage. The first is to provide Application Default Credentials. To do so, set the env var as noted under the Google Gemini & Vertex AI configuration. Make sure the ADC provides appropriate access to the storage. If you set the ADC, you only need to set the GOOGLE_BUCKET_NAME in the list below. If not using ADC, fill in all the variables in this table:
| Environment Variable | Description | Type | Default Value |
|---|---|---|---|
GOOGLE_PROJECT_ID | Google Cloud Project ID. | string | null |
GOOGLE_CLIENT_EMAIL | Client email from GCS service account JSON. | string | null |
GOOGLE_PRIVATE_KEY | Private key from GCS service account JSON. | string | null |
GOOGLE_BUCKET_NAME | Name of the Google Cloud Storage bucket. | string | null |
S3-Compatible Storage (e.g., MinIO or Cloudflare R2)
| Environment Variable | Description | Type | Default Value |
|---|---|---|---|
S3_COMPATIBLE_ENDPOINT | Endpoint URL for the S3-compatible service (e.g., MinIO). | string | http://localhost:9000 |
S3_COMPATIBLE_ACCESS_KEY_ID | Access Key ID for the S3-compatible service. | string | minioadmin |
S3_COMPATIBLE_SECRET_ACCESS_KEY | Secret Access Key for the S3-compatible service. | string | minioadmin |
S3_COMPATIBLE_BUCKET_NAME | Bucket name in the S3-compatible service. | string | academicid |
S3_COMPATIBLE_FORCE_PATH_STYLE | Whether to force path-style addressing (true or false). Defaults to true if not set. | boolean | true |
S3_COMPATIBLE_ENDPOINT_SERVICE | Service name as defined in the Docker Compose file if storage is within the same Compose project as the AcademicID services (e.g., minio) – this is required for communication between Docker Containers, see the example.env file for more information. | string | minio |
S3_COMPATIBLE_REGION | Region for the S3-compatible service. | string | auto |