Skip to content

Commit 12c14e2

Browse files
committed
docs(storage): add backlinks to S3-compatible providers (R2, MinIO, Ceph, B2, RustFS) and backends
1 parent f3c7b14 commit 12c14e2

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

apps/docs/content/docs/en/self-hosting/object-storage.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Sim stores every uploaded file — knowledge base documents, chat attachments, e
1313
| Backend | When to use |
1414
|---------|-------------|
1515
| **Local disk** | Single-node Docker, local development, evaluation |
16-
| **AWS S3** | Production, especially when running more than one app replica |
17-
| **Azure Blob** | Production on Azure |
16+
| **[AWS S3](https://aws.amazon.com/s3/)** | Production, especially when running more than one app replica |
17+
| **[Azure Blob](https://learn.microsoft.com/azure/storage/blobs/)** | Production on Azure |
1818

1919
<Callout type="warning">
2020
Local disk writes to the container's `/uploads` directory. Files are lost when the container is recreated unless that path is on a persistent volume, and they are **not** shared across replicas. For any multi-replica or production deployment, use S3 or Azure Blob.
@@ -203,7 +203,7 @@ A full Helm example lives at `helm/sim/examples/values-azure.yaml`.
203203

204204
## Set up an S3-compatible provider (R2, MinIO, B2)
205205

206-
Sim works with any S3-compatible store by pointing the S3 client at a custom endpoint. Configure it exactly like AWS S3 (buckets, access key, secret), then add `S3_ENDPOINT` — and `S3_FORCE_PATH_STYLE` where the provider requires path-style addressing.
206+
Sim works with any S3-compatible store by pointing the S3 client at a custom endpoint. Configure it exactly like AWS S3 (buckets, access key, secret), then add `S3_ENDPOINT` — and `S3_FORCE_PATH_STYLE` where the provider requires path-style addressing. Verified with [Cloudflare R2](https://developers.cloudflare.com/r2/), [MinIO](https://min.io/), [Backblaze B2](https://www.backblaze.com/cloud-storage), and [RustFS](https://rustfs.com/).
207207

208208
<Callout type="info">
209209
`S3_ENDPOINT` is trusted operator configuration, so it is used as-is — `http://` and private hosts are accepted (no SSRF/HTTPS gate). Don't wire it to untrusted input.
@@ -219,7 +219,7 @@ Sim works with any S3-compatible store by pointing the S3 client at a custom end
219219
<Tabs items={['Cloudflare R2', 'MinIO', 'RustFS']}>
220220
<Tab value="Cloudflare R2">
221221

222-
R2 uses virtual-hosted style (the default) and the region `auto`:
222+
[Cloudflare R2](https://developers.cloudflare.com/r2/api/s3/) uses virtual-hosted style (the default) and the region `auto`:
223223

224224
```bash
225225
AWS_REGION=auto
@@ -235,7 +235,7 @@ Leave `S3_FORCE_PATH_STYLE` unset — R2 supports the default virtual-hosted add
235235
</Tab>
236236
<Tab value="MinIO">
237237

238-
MinIO (and Ceph RGW) need path-style addressing and accept any region string:
238+
[MinIO](https://min.io/docs/minio/linux/index.html) (and [Ceph RGW](https://docs.ceph.com/en/latest/radosgw/)) need path-style addressing and accept any region string:
239239

240240
```bash
241241
AWS_REGION=us-east-1
@@ -252,7 +252,7 @@ S3_BUCKET_NAME=myorg-sim-workspace-files
252252
</Tab>
253253
<Tab value="RustFS">
254254

255-
RustFS is a Rust-based, S3-compatible store (a MinIO drop-in). Configure it exactly like MinIO — path-style, any region string, SigV4 access key/secret:
255+
[RustFS](https://rustfs.com/) is a Rust-based, S3-compatible store (a MinIO drop-in). Configure it exactly like MinIO — path-style, any region string, SigV4 access key/secret:
256256

257257
```bash
258258
AWS_REGION=us-east-1

0 commit comments

Comments
 (0)