Skip to content

Commit 74afb56

Browse files
committed
docs(storage): add RustFS as an S3-compatible provider example
1 parent 59748bb commit 74afb56

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Sim works with any S3-compatible store by pointing the S3 client at a custom end
216216
- Configure a **CORS policy** on the bucket that allows your Sim origin (`PUT`, `GET`, and the `Authorization` / `Content-Type` / `x-amz-*` headers). This applies to AWS S3 too — R2 and MinIO are no different.
217217
</Callout>
218218

219-
<Tabs items={['Cloudflare R2', 'MinIO']}>
219+
<Tabs items={['Cloudflare R2', 'MinIO', 'RustFS']}>
220220
<Tab value="Cloudflare R2">
221221

222222
R2 uses virtual-hosted style (the default) and the region `auto`:
@@ -249,6 +249,23 @@ S3_BUCKET_NAME=myorg-sim-workspace-files
249249

250250
`http://` works server-side, but since the browser uploads directly to this endpoint, prefer a TLS endpoint your users can reach (a mixed-content `http://` target will be blocked on an `https://` Sim origin).
251251

252+
</Tab>
253+
<Tab value="RustFS">
254+
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:
256+
257+
```bash
258+
AWS_REGION=us-east-1
259+
S3_ENDPOINT=https://rustfs.example.com # must be reachable from users' browsers
260+
S3_FORCE_PATH_STYLE=true
261+
AWS_ACCESS_KEY_ID=<rustfs-access-key>
262+
AWS_SECRET_ACCESS_KEY=<rustfs-secret-key>
263+
S3_BUCKET_NAME=myorg-sim-workspace-files
264+
# ...remaining S3_*_BUCKET_NAME vars, one bucket each
265+
```
266+
267+
The same browser-reachability and CORS requirements apply.
268+
252269
</Tab>
253270
</Tabs>
254271

0 commit comments

Comments
 (0)