Skip to content

Commit

Permalink
some doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
inian committed Apr 18, 2024
1 parent 94e5c67 commit 6afefbf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions apps/docs/content/guides/storage/s3/authentication.mdx
Expand Up @@ -9,19 +9,19 @@ sidebar_label: 'S3'
You have two options to authenticate with Supabase Storage S3:

- Using the generated S3 access keys from your [project settings](/dashboard/project/_/settings/storage) (Intended exclusively for server-side use)
- Using a Session Token, which will allow you to authenticate with a user JWT token and provide limited access via Row Level Security
- Using a Session Token, which will allow you to authenticate with a user JWT token and provide limited access via Row Level Security (RLS).

## S3 access keys

<Admonition type="danger" label="Keep these credentials secure">

They provide full access to all S3 operations across all buckets, bypassing RLS policies.
S3 access keys provide full access to all S3 operations across all buckets and bypass RLS policies. These are meant to be used only on the server.

</Admonition>

To authenticate with S3 on the server, you need to generate a pair of credentials (Access Key ID and Secret Access Key) from your [project settings](/dashboard/project/_/settings/storage).
To authenticate with S3, generate a pair of credentials (Access Key ID and Secret Access Key), copy the endpoint and region from the [project settings page](/dashboard/project/_/settings/storage).

You can use these credentials to authenticate with Supabase Storage S3 using any S3-compatible service.
This is all the information you need to connect to Supabase Storage using any S3-compatible service.

<img alt="Storage S3 Access keys" src="/docs/img/storage/s3-credentials.png" width="100%" />

Expand All @@ -38,7 +38,7 @@ You can use these credentials to authenticate with Supabase Storage S3 using any

const client = new S3Client({
forcePathStyle: true,
region: 'project_region', // the region selected during project creation
region: 'project_region',
endpoint: 'https://project_ref.supabase.co/storage/v1/s3',
credentials: {
accessKeyId: 'your_access_key_id',
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/guides/storage/s3/compatibility.mdx
Expand Up @@ -6,9 +6,9 @@ subtitle: 'Learn about the compatibility of Supabase Storage with S3.'
sidebar_label: 'S3'
---

Supabase Storage introduces S3 compatibility. You can use any S3 client to interact with your Supabase Storage.
Supabase Storage is compatible with the S3 protocol. You can use any S3 client to interact with your Storage objects.

All operations are interoperable across S3, Resumable Upload Protocol (TUS), and the REST API, meaning that you can upload with TUS and list with S3, or upload with S3 and serve it with REST.
We support standard, resumable (TUS) and S3 protocol for uploads and they are interoperable. You can upload a file with the S3 protocol and list it with our REST API or upload with TUS and list with S3.

<Admonition type="note">

Expand Down

0 comments on commit 6afefbf

Please sign in to comment.