Skip to content

Commit cecf15c

Browse files
committed
docs(backups): clarify S3-compatible endpoint configuration
1 parent 84b2d7f commit cecf15c

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

docs/deploy/configuration/backups.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Note multiple providers can be enabled simultaneously.
126126

127127
### S3 (AWS or S3-compatible)
128128

129-
- Works with AWS S3 and S3-compatible services (e.g., MinIO)
129+
- Works with Amazon S3 and any S3-compatible object store (for example, Backblaze B2, Cloudflare R2, or MinIO)
130130
- Supports multi-node deployments
131131
- Recommended for production use
132132

@@ -148,25 +148,42 @@ This configuration applies to any S3-compatible backend.
148148
| --- | --- | --- |
149149
| `BACKUP_S3_BUCKET` | yes | The name of the S3 bucket for all backups. |
150150
| `BACKUP_S3_PATH` | no | The root path inside your bucket that all your backups will be copied into and retrieved from. <br/><br/>Optional, defaults to `""` which means that the backups will be stored in the bucket root instead of a sub-folder. |
151-
| `BACKUP_S3_ENDPOINT` | no | The S3 endpoint to be used. <br/><br/>Optional, defaults to `"s3.amazonaws.com"`. |
151+
| `BACKUP_S3_ENDPOINT` | no | The S3 endpoint host to use, optionally including a port. Do not include an `http://` or `https://` scheme; TLS is controlled by `BACKUP_S3_USE_SSL`. <br/><br/>Optional, defaults to `"s3.amazonaws.com"`. |
152152
| `BACKUP_S3_USE_SSL` | no | Whether the connection should be secured with SSL/TLS. <br/><br/>Optional, defaults to `"true"`. |
153153

154-
#### S3 Configuration (AWS-specific)
154+
#### S3 authentication
155155

156-
For AWS, provide Weaviate with authentication details. You can choose between access-key or ARN-based authentication:
156+
For Amazon S3, provide Weaviate with authentication details. You can choose between AWS IAM/ARN-based authentication or access-key authentication. For S3-compatible object stores, use access-key authentication.
157157

158-
#### Option 1: With IAM and ARN roles
158+
#### Option 1: With AWS IAM and ARN roles
159159

160-
The backup module will first try to authenticate itself using AWS IAM. If the authentication fails then it will try to authenticate with `Option 2`.
160+
The backup module first tries to authenticate using AWS IAM. If IAM authentication fails, it falls back to the configured access key and secret access key.
161161

162162
#### Option 2: With access key and secret access key
163163

164+
These environment variables are named for AWS, but they also apply to S3-compatible object stores that issue access-key credentials.
165+
164166
| Environment variable | Description |
165167
| --- | --- |
166168
| `AWS_ACCESS_KEY_ID` | The id of the AWS access key for the desired account. |
167169
| `AWS_SECRET_ACCESS_KEY` | The secret AWS access key for the desired account. |
168170
| `AWS_REGION` | (Optional) The AWS Region. If not provided, the module will try to parse `AWS_DEFAULT_REGION`. |
169171

172+
#### S3-compatible endpoints
173+
174+
To use an S3-compatible object store, set `BACKUP_S3_ENDPOINT` to the provider's S3 endpoint host, optionally including a port, and authenticate with `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. Set `AWS_REGION` if your provider requires one.
175+
176+
```
177+
ENABLE_MODULES=backup-s3
178+
BACKUP_S3_BUCKET=weaviate-backups
179+
BACKUP_S3_ENDPOINT=your-s3-endpoint.example.com # host[:port], no scheme
180+
BACKUP_S3_USE_SSL=true
181+
AWS_ACCESS_KEY_ID=<your-access-key-id>
182+
AWS_SECRET_ACCESS_KEY=<your-secret-access-key>
183+
# Optional: set if your provider requires a region.
184+
# AWS_REGION=<your-region>
185+
```
186+
170187

171188
### GCS (Google Cloud Storage)
172189

0 commit comments

Comments
 (0)