Skip to content

docs: clarify region requirement for S3-compatible endpoints #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidmyriel wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −5
Open

docs: clarify region requirement for S3-compatible endpoints #851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions apps/docs/connectors/s3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Connect Amazon S3 or S3-compatible storage to sync files into your
icon: "aws"
---

Connect Amazon S3 buckets or S3-compatible storage services (MinIO, DigitalOcean Spaces, Cloudflare R2) to sync files into your Supermemory knowledge base.
Connect Amazon S3 buckets or S3-compatible storage services (MinIO, DigitalOcean Spaces, Cloudflare R2, Tigris) to sync files into your Supermemory knowledge base.

<Note>
The S3 connector requires a **Scale Plan** or higher. You can also create S3 connections directly from the [Supermemory Console](https://console.supermemory.ai).
Expand Down Expand Up @@ -79,24 +79,27 @@ The S3 connector requires a **Scale Plan** or higher. You can also create S3 con

## S3-Compatible Services

Use a custom `endpoint` to connect to S3-compatible storage:
Use a custom `endpoint` to connect to S3-compatible storage. These services don't use AWS-style regions, but `region` is still required for request signing — set it to `auto` (or any non-empty value) and the service will ignore it.

```typescript
// MinIO
const connection = await client.connections.create('s3', {
accessKeyId: 'minio-key',
secretAccessKey: 'minio-secret',
bucket: 'my-bucket',
region: 'us-east-1',
region: 'auto',
endpoint: 'https://minio.example.com',
containerTags: ['minio-sync']
});

// DigitalOcean Spaces
endpoint: 'https://nyc3.digitaloceanspaces.com'
endpoint: 'https://nyc3.digitaloceanspaces.com' // region: 'auto'

// Cloudflare R2
endpoint: 'https://ACCOUNT_ID.r2.cloudflarestorage.com'
endpoint: 'https://ACCOUNT_ID.r2.cloudflarestorage.com' // region: 'auto'

// Tigris
endpoint: 'https://fly.storage.tigris.dev' // region: 'auto'
```

## Prefix Filtering
Expand Down