diff --git a/apps/docs/components/MDX/product_management_sql_template.mdx b/apps/docs/components/MDX/product_management_sql_template.mdx index e54e89e1ca4..48ee1ff8112 100644 --- a/apps/docs/components/MDX/product_management_sql_template.mdx +++ b/apps/docs/components/MDX/product_management_sql_template.mdx @@ -15,7 +15,7 @@ insert into storage.buckets (id, name) values ('Product Image', 'Product Image'); -- Set up access controls for storage. --- See https://supabase.com/docs/guides/storage#policy-examples for more details. +-- See https://supabase.com/docs/guides/storage/security/access-control#policy-examples for more details. CREATE POLICY "Enable read access for all users" ON "storage"."objects" AS PERMISSIVE FOR SELECT TO public diff --git a/apps/docs/components/MDX/user_management_quickstart_sql_template.mdx b/apps/docs/components/MDX/user_management_quickstart_sql_template.mdx index ba55c4aeab3..aa552b6af65 100644 --- a/apps/docs/components/MDX/user_management_quickstart_sql_template.mdx +++ b/apps/docs/components/MDX/user_management_quickstart_sql_template.mdx @@ -43,7 +43,7 @@ insert into storage.buckets (id, name) values ('avatars', 'avatars'); -- Set up access controls for storage. --- See https://supabase.com/docs/guides/storage#policy-examples for more details. +-- See https://supabase.com/docs/guides/storage/security/access-control#policy-examples for more details. create policy "Avatar images are publicly accessible." on storage.objects for select using (bucket_id = 'avatars'); diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index d92267b6b1d..1ccc936af4f 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -975,18 +975,64 @@ export const storage: NavMenuConstant = { { name: 'Overview', url: '/guides/storage' }, { name: 'Quickstart', url: '/guides/storage/quickstart' }, { - name: 'Fundamentals', + name: 'Buckets', url: undefined, items: [ - { name: 'Uploading files to Storage', url: '/guides/storage/uploads' }, - { name: 'Image Transformations', url: '/guides/storage/image-transformations' }, - { name: 'How caching works', url: '/guides/storage/cdn' }, + { name: 'Fundamentals', url: '/guides/storage/buckets/fundamentals' }, + { name: 'Creating Buckets', url: '/guides/storage/buckets/creating-buckets' }, ], }, { - name: 'Access and security', + name: 'Security', url: undefined, - items: [{ name: 'Access Control', url: '/guides/storage/access-control' }], + items: [{ name: 'Access Control', url: '/guides/storage/security/access-control' }], + }, + { + name: 'Uploads', + url: undefined, + items: [ + { name: 'Standard Uploads', url: '/guides/storage/uploads/standard-uploads' }, + { name: 'Resumable Uploads', url: '/guides/storage/uploads/resumable-uploads' }, + { name: 'Limits', url: '/guides/storage/uploads/file-limits' }, + ], + }, + { + name: 'Serving', + url: undefined, + items: [ + { name: 'Serving assets', url: '/guides/storage/serving/downloads' }, + { name: 'Image Transformations', url: '/guides/storage/serving/image-transformations' }, + ], + }, + { + name: 'CDN', + url: undefined, + items: [ + { name: 'Fundamentals', url: '/guides/storage/cdn/fundamentals' }, + { name: 'Smart CDN', url: '/guides/storage/cdn/smart-cdn' }, + { name: 'Metrics', url: '/guides/storage/cdn/metrics' }, + ], + }, + { + name: 'Debugging', + url: undefined, + items: [ + { name: 'Logs', url: '/guides/storage/debugging/logs' }, + { name: 'Error Codes', url: '/guides/storage/debugging/error-codes' }, + ], + }, + { + name: 'Schema', + url: undefined, + items: [ + { name: 'Database Design', url: '/guides/storage/schema/design' }, + { name: 'Helper Functions', url: '/guides/storage/schema/helper-functions' }, + ], + }, + { + name: 'Going to production', + url: undefined, + items: [{ name: 'Scaling', url: '/guides/storage/production/scaling' }], }, ], } diff --git a/apps/docs/docs/ref/python/release-notes.mdx b/apps/docs/docs/ref/python/release-notes.mdx index 1deb6705f7e..6d76c242f77 100644 --- a/apps/docs/docs/ref/python/release-notes.mdx +++ b/apps/docs/docs/ref/python/release-notes.mdx @@ -7,4 +7,4 @@ The community is actively working on the library and we will be upgrading the Au ## Storage Transformations -We currently support [image transformations](https://supabase.com/docs/guides/storage/image-transformations) in our storage library. +We currently support [image transformations](https://supabase.com/docs/guides/storage/serving/image-transformations) in our storage library. diff --git a/apps/docs/pages/guides/auth/sso/auth-sso-saml.mdx b/apps/docs/pages/guides/auth/sso/auth-sso-saml.mdx index b95999b2eb3..f2db1cd981a 100644 --- a/apps/docs/pages/guides/auth/sso/auth-sso-saml.mdx +++ b/apps/docs/pages/guides/auth/sso/auth-sso-saml.mdx @@ -37,25 +37,25 @@ Please note that SAML 2.0 support is offered on plans Pro and above. Check the [ The number of SAML and SSO acronyms can often be overwhelming. Here's a glossary which you can refer back to at any time: -- **Identity Provider**, **IdP**, or **IDP** +- **Identity Provider**, **IdP**, or **IDP** An identity provider is a service that manages user accounts at a company or organization. It can verify the identity of a user and exchange that information with your Supabase project and other applications. It acts as a single source of truth for user identities and access rights. Commonly used identity providers are: Microsoft Active Directory (Azure AD, Microsoft Entra), Okta, Google Workspaces (GSuite), PingIdentity, OneLogin, and many others. There are also self-hosted and on-prem versions of identity providers, and sometimes they are accessible only by having access to a company VPN or being in a specific building. -- **Service Provider**, **SP** +- **Service Provider**, **SP** This is the software that is asking for user information from an identity provider. In Supabase, this is your project's Auth server. -- **Assertion** +- **Assertion** An assertion is a statement issued by an identity provider that contains information about a user. -- **EntityID** +- **EntityID** A globally unique ID (usually a URL) that identifies an Identity Provider or Service Provider across the world. -- **NameID** +- **NameID** A unique ID (usually an email address) that identifies a user at an Identity Provider. -- **Metadata** +- **Metadata** An XML document that describes the features and configuration of an Identity Provider or Service Provider. It can be as a standalone document or as a URL. Usually (but not always) the `EntityID` is the URL at which you can access the Metadata. -- **Certificate** +- **Certificate** Supabase Auth (the Service Provider) trusts assertions from an Identity Provider based on the signature attached to the assertion. The signature is verified according to the certificate present in the Metadata. -- **Assertion Consumer Service (ACS) URL** +- **Assertion Consumer Service (ACS) URL** This is one of the most important SAML URLs. It is the URL where Supabase Auth will accept assertions from an identity provider. Basically, once the identity provider verifies the user's identity it will redirect to this URL and the redirect request will contain the assertion. -- **Binding (Redirect, POST, or Artifact)** +- **Binding (Redirect, POST, or Artifact)** This is a description of the way an identity provider communicates with Supabase Auth. When using the Redirect binding, the communication occurs using HTTP 301 redirects. When it's `POST`, it's using `POST` requests sent with `
` elements on a page. When using Artifact, it's using a more secure exchange over a Redirect or `POST`. -- **RelayState** +- **RelayState** State used by Supabase Auth to hold information about a request to verify the identity of a user. ## Important SAML 2.0 information @@ -81,11 +81,11 @@ Alternatively, you can use the `supabase sso info --project-ref ` User accounts and identities created via SSO differ from regular (email, phone, password, social login...) accounts in these ways: -- **No automatic linking.** +- **No automatic linking.** Each user account verified using a SSO identity provider will not be automatically linked to existing user accounts in the system. That is, if a user `jane.doe@company.com` had signed up with a password, and then uses their company SSO login with your project, there will be two `jane.doe@company.com` user accounts in the system. -- **Emails are not necessarily unique.** +- **Emails are not necessarily unique.** Given the behavior with no automatic linking, email addresses are no longer a unique identifier for a user account. Please always use the user's UUID to correctly reference user accounts. -- **Sessions may have a maximum duration.** +- **Sessions may have a maximum duration.** Depending on the configuration of the identity provider, a login session established with SSO may forcibly log out a user after a certain period of time. ### Row Level Security @@ -103,7 +103,7 @@ Here are some commonly used statements to extract SSO related information from t -If you use [Multi-Factor Authentication](/guides/auth/auth-mfa) with SSO, the `amr` array may have a different method at index `0`! +If you use [Multi-Factor Authentication](/docs/guides/auth/auth-mfa) with SSO, the `amr` array may have a different method at index `0`! diff --git a/apps/docs/pages/guides/functions/kysely-postgres.mdx b/apps/docs/pages/guides/functions/kysely-postgres.mdx index 3987a77e45d..211a520b4c3 100644 --- a/apps/docs/pages/guides/functions/kysely-postgres.mdx +++ b/apps/docs/pages/guides/functions/kysely-postgres.mdx @@ -16,7 +16,7 @@ export const meta = { > -Supabase Edge Functions can [connect directly to your Postgres database](/guides/functions/connect-to-postgres) to execute SQL queries. [Kysely](https://github.com/kysely-org/kysely#kysely) is a type-safe and autocompletion-friendly typescript SQL query builder. +Supabase Edge Functions can [connect directly to your Postgres database](/docs/guides/functions/connect-to-postgres) to execute SQL queries. [Kysely](https://github.com/kysely-org/kysely#kysely) is a type-safe and autocompletion-friendly typescript SQL query builder. Combining Kysely with Deno Postgres gives you a convenient developer experience for interacting directly with your Postgres database. diff --git a/apps/docs/pages/guides/getting-started/features.mdx b/apps/docs/pages/guides/getting-started/features.mdx index 4d9b63409fd..28e01945063 100755 --- a/apps/docs/pages/guides/getting-started/features.mdx +++ b/apps/docs/pages/guides/getting-started/features.mdx @@ -117,15 +117,15 @@ Supabase Storage makes it simple to store and serve files. [Docs](/docs/guides/s ### Resumable uploads -Upload large files easily using resumable uploads. [Docs](/docs/guides/storage/uploads). +Upload large files easily using resumable uploads. [Docs](/docs/guides/storage/uploads/resumable-uploads). ### Storage CDN -Cache large files using the Supabase CDN. [Docs](/docs/guides/storage-cdn). +Cache large files using the Supabase CDN. [Docs](/docs/guides/storage/cdn/fundamentals). ### Image Transformations -Transform images on the fly. [Docs](/docs/guides/storage/image-transformations). +Transform images on the fly. [Docs](/docs/guides/storage/serving/image-transformations).
diff --git a/apps/docs/pages/guides/storage/access-control.mdx b/apps/docs/pages/guides/storage/access-control.mdx deleted file mode 100644 index a7fcf337af5..00000000000 --- a/apps/docs/pages/guides/storage/access-control.mdx +++ /dev/null @@ -1,177 +0,0 @@ -import Layout from '~/layouts/DefaultGuideLayout' - -export const meta = { - id: 'storage-access-control', - title: 'Access Control', - description: 'Manage who can access your Supabase Storage files.', - subtitle: 'Manage who can access your Supabase Storage files.', - tocVideo: '4ERX__Y908k', -} - -Supabase Storage is designed to work perfectly with [Postgres Row Level Security](/docs/guides/database/postgres/row-level-security) (RLS). - -You can use RLS to create [Security Access Policies](https://www.postgresql.org/docs/current/sql-createpolicy.html) that are incredibly powerful and flexible, allowing you to restrict access based on your business needs. - -## Policies - -Policies are just SQL, and they're easy once you get the hang of them. For example, here is a Policy that allows public access to any files in a bucket called "my_bucket_id". - -```sql -create policy "Public Access" -on storage.objects -for select -- Allow read access -to anon, authenticated -- Allow access to anonymous and authenticated users -using ( bucket_id = 'my_bucket_id' ); -- Identify the bucket -``` - -An easy way to get started would be to create RLS policies for `SELECT`, `INSERT`, `UPDATE`, `DELETE` operations and restrict the policies to meet your security requirements. For example, one can start with the following `INSERT` policy: - -```sql -create policy "policy_name" -ON storage.objects -for insert with check ( - true -); -``` - -and modify it to only allow authenticated users to upload assets to a specific bucket by changing it to: - -```sql -create policy "policy_name" -on storage.objects for insert to authenticated with check ( - -- restrict bucket - bucket_id = 'my_bucket_id' -); -``` - -## Metadata storage - -Supabase Storage stores metadata in the `objects` and `buckets` table in the storage schema. - -To allow read access to files, the RLS policy must allow users to `SELECT` the `objects` table and for uploading a new object, the RLS policy must grant users access to `INSERT` into the `objects` table and so on. The mapping between the different API calls and the database permissions required is documented in the [Reference docs](/docs/reference/javascript/storage-createbucket). - -## Public and private buckets - -Storage buckets are private by default. For private buckets, you can access objects via the [download](/docs/reference/javascript/storage-from-download) method. This corresponds to `/object/auth/` API endpoint. Alternatively, you can create a publicly shareable URL with an expiry date using the [createSignedUrl](/docs/reference/javascript/storage-from-createsignedurl) method which calls the `/object/sign/` API. - -For public buckets, you can access the assets directly without a token or an Authorisation header. The [getPublicUrl](/docs/reference/javascript/storage-from-getpublicurl) helper method returns the full public URL for an asset. This calls the `/object/public/` API endpoint internally. While no authorization is required for accessing objects in a public bucket, [proper access control](#policies) is required for other operations like uploading, deleting objects from public buckets as well. - -Public buckets also tend to have [better performance](/docs/guides/storage-cdn#public-vs-private-buckets). - -The URLs to access storage endpoints are prefixed with /storage/v1. For example, on the hosted Platform they will be: - -https://[project_ref].supabase.co/storage/v1/object/public/[id] - -You can access the storage API directly with the same endpoint. See the API docs for a full list of operations available. - -## Helper functions - -Supabase Storage provides SQL helper functions which you can use in your database queries and RLS policies. - -### `storage.filename()` - -Returns the name of a file. For example, if your file is stored in `public/subfolder/avatar.png` it would return: `'avatar.png'` - -**Usage** - -This example demonstrates how you would allow any user to download a file called `favicon.ico`: - -```sql -create policy "Allow authenticated uploads" -on storage.objects -for select -to public -using ( - storage.filename(name) = 'favicon.ico' -); -``` - -### `storage.foldername()` - -Returns an array path, with all of the subfolders that a file belongs to. For example, if your file is stored in `public/subfolder/avatar.png` it would return: `[ 'public', 'subfolder' ]` - -**Usage** - -This example demonstrates how you would allow authenticated users to upload files to a folder called `private`: - -```sql -create policy "Allow authenticated uploads" -on storage.objects -for insert -to authenticated -with check ( - storage.foldername(name)[1] = 'private' -); -``` - -### `storage.extension()` - -Returns the extension of a file. For example, if your file is stored in `public/subfolder/avatar.png` it would return: `'png'` - -**Usage** - -This example demonstrates how you would allow restrict uploads to only PNG files inside a bucket called `cats`: - -```sql -create policy "Only allow PNG uploads" -on storage.objects -for insert -to authenticated -with check ( - bucket_id = 'cats' and storage.extension(name) = 'png' -); -``` - -## Usage - -Row Level Security is extremely versatile, since it simply uses SQL to express access rules for your data. You can learn more about RLS in the [Database docs](/docs/guides/database/postgres/row-level-security). - -### Allowing public access to a bucket - -Allow public access to any files in the "public" bucket: - -```sql -create policy "Public Access" -on storage.objects for select -to public -using ( bucket_id = 'public' ); -``` - -### Allowing logged-in access to a bucket - -Allow logged-in access to any files in the "restricted" bucket: - -```sql -create policy "Restricted Access" -on storage.objects for select -to authenticated -using ( bucket_id = 'restricted' ); -``` - -### Allowing individual access to a file - -Allow a user to access their own files: - -```sql -create policy "Individual user Access" -on storage.objects for select -to authenticated -using ( auth.uid() = owner ); -``` - ---- - -{/* Finish with a video. This also appears in the Sidebar via the "tocVideo" metadata */} - -
- -
- -export const Page = ({ children }) => - -export default Page diff --git a/apps/docs/pages/guides/storage/buckets/creating-buckets.mdx b/apps/docs/pages/guides/storage/buckets/creating-buckets.mdx new file mode 100644 index 00000000000..cedf1723483 --- /dev/null +++ b/apps/docs/pages/guides/storage/buckets/creating-buckets.mdx @@ -0,0 +1,93 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-creating-buckets', + title: 'Creating Buckets', + description: 'Learn how to create Supabase Storage buckets.', + sidebar_label: 'Buckets', +} + +You can create a bucket using the Supabase Dashboard. Since storage is interoperable with your Postgres database, you can also use SQL or our client libraries. +Here we create a bucket called "avatars": + + + + +```js +// Use the JS library to create a bucket. + +const { data, error } = await supabase.storage.createBucket('avatars', { + public: true, // default: false +}) +``` + +[Reference.](/docs/reference/javascript/storage-createbucket) + + + + + +1. Go to the [Storage](https://supabase.com/dashboard/project/_/storage/buckets) page in the Dashboard. +2. Click **New Bucket** and enter a name for the bucket. +3. Click **Create Bucket**. + + + + +```sql +-- Use Postgres to create a bucket. + +insert into storage.buckets + (id, name, public) +values + ('avatars', 'avatars', true); +``` + + + + +```dart +void main() async { + final supabase = SupabaseClient('supabaseUrl', 'supabaseKey'); + + final storageResponse = await supabase + .storage + .createBucket('avatars'); +} +``` + +[Reference.](https://pub.dev/documentation/storage_client/latest/storage_client/SupabaseStorageClient/createBucket.html) + + + + +## Restricting uploads + +When creating a bucket you can add additional configurations to restrict the type or size of files you want this bucket to contain. +For example, imagine you want to allow your users to upload only images to the `avatars` bucket and the size must not be greater than 1MB. + +You can achieve the following by providing: `allowedMimeTypes` and `maxFileSize` + +```js +// Use the JS library to create a bucket. + +const { data, error } = await supabase.storage.createBucket('avatars', { + public: true, + allowedMimeTypes: ['image/*'], + maxFileSize: '1MB', +}) +``` + +If an upload request doesn't meet the above restrictions it will be rejected. + +For more information check [File Limits](/docs/guides/storage/uploads/file-limits) Section. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/buckets/fundamentals.mdx b/apps/docs/pages/guides/storage/buckets/fundamentals.mdx new file mode 100644 index 00000000000..a0ab22e26b9 --- /dev/null +++ b/apps/docs/pages/guides/storage/buckets/fundamentals.mdx @@ -0,0 +1,46 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-bucket-public-and-private', + title: 'Storage Buckets', + description: 'Learn how Supabase Storage Buckets works.', + sidebar_label: 'Buckets', +} + +Buckets allow you to keep your files organized and determines the [Access Model](#access-model) for your assets. [Upload restrictions](/docs/guides/storage/buckets/creating-buckets#restricting-uploads) like max file size and allowed content types are also defined at the bucket level. + +## Access Model + +There are 2 access models for buckets, **public** and **private** buckets. + +### Private Buckets + +When a bucket is set to **Private** all operations are subject to access control via [RLS policies](/docs/guides/storage/uploads/access-control). This also applies when downloading assets. Buckets are private by default. + +The only ways to download assets within a private bucket is to: + +- Use the [download method](/docs/reference/javascript/storage-from-download) by providing a authorization header containing your user's JWT. The RLS policy you create on the `storage.objects` table will use this user to determine if they have access. +- Create a signed URL with the [createSignedUrl method](/docs/reference/javascript/storage-from-createsignedurl) that can be accessed for a limited time. + +#### Example Use Cases: + +- Uploading users' sensitive documents +- Securing private assets by using RLS to set up fine-grain access controls + +### Public Buckets + +When a bucket is designated as 'Public,' it effectively bypasses access controls for both retrieving and serving files within the bucket. This means that anyone who possesses the asset URL can readily access the file. + +Access control is still enforced for other types of operations including uploading, deleting, moving, and copying. + +#### Example Use Cases: + +- User profile pictures +- User public media +- Blog post content + +Public buckets are more performant than private buckets since they are [cached differently](/docs/guides/storage/cdn/fundamentals#public-vs-private-buckets). + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/cdn.mdx b/apps/docs/pages/guides/storage/cdn.mdx deleted file mode 100644 index d586f8de94f..00000000000 --- a/apps/docs/pages/guides/storage/cdn.mdx +++ /dev/null @@ -1,125 +0,0 @@ -import Layout from '~/layouts/DefaultGuideLayout' - -export const meta = { - id: 'storage-cdn', - title: 'Storage CDN', - description: 'Learn how Supabase Storage caches objects with a CDN.', - sidebar_label: 'CDN', -} - -All assets uploaded to Supabase Storage are cached on a Content Delivery Network (CDN) to improve the latency for users all around the world. CDNs are a geographically distributed set of servers or **nodes** which caches content from an **origin server**. For Supabase Storage, the origin is the storage server running in the [same region as your project](https://supabase.com/dashboard/project/_/settings/general). Aside from performance, CDNs also help with security and availability by mitigating Distributed Denial of Service and other application attacks. - -## Basic CDN - -Our basic CDN caches objects based on the cache time set when uploading objects. - -### Example - -Let's walk through an example of how a CDN helps with performance. - -A new bucket is created for a Supabase project launched in Singapore. All requests to the Supabase Storage API are routed to the CDN first. - -A user from the United States requests an object and is routed to the U.S. CDN. At this point, that CDN node does not have the object in its cache and pings the origin server in Singapore. -![CDN cache miss](/docs/img/cdn-cache-miss.png) - -Another user, also in the United States, requests the same object and is served directly from the CDN cache in the United States instead of routing the request back to Singapore. -![CDN cache hit](/docs/img/cdn-cache-hit.png) - -### Cache duration - -By default, assets are cached both in the CDN and in the user's browser for 1 hour. After this, the CDN nodes ping the storage server to see if an object has been updated. You can modify this cache time when you are [uploading](/docs/reference/javascript/storage-from-upload) or [updating](/docs/reference/javascript/storage-from-update) an object by modifying the `cacheControl` parameter. -If you expect the object to not change at a given URL, setting a longer cache duration is preferable. - -If you need to update the version of the object stored in the CDN, there are various cache-busting techniques you can use. The most common way to do this is to add a version query parameter in the URL. - -For example, you can use a URL like `/storage/v1/object/sign/profile-pictures/cat.jpg?token=eyJh...&version=1` in your applications and set a long cache time of 1 year. - -When you want to update the cat picture, you can increment the version query parameter in the URL. The CDN treats `/storage/v1/object/sign/profile-pictures/cat.jpg?token=eyJh...&version=2` as a new object and pings the origin for the updated version. - -If your asset is updated frequently, we recommend that you re-upload the new asset in a different key, this way you'll always have the latest changes available immediately. - -Note that CDNs might still evict your object from their cache if it has not been requested for a while from a specific region. For example, if no user from United States requests your object, it will be removed from the CDN cache even if you set a very long cache control duration. - -The cache status of a particular request is sent in the `cf-cache-status` header. A cache status of `MISS` indicates that the CDN node did not have the object in its cache and had to ping the origin to get it. A cache status of `HIT` indicates that the object was sent directly from the CDN. - -## Smart CDN Caching - - - -Smart CDN caching is automatically enabled for [Pro plan and above](https://supabase.com/pricing). - - - -With Smart CDN caching enabled, the asset metadata in your database is synchronized to the edge. This automatically revalidates the cache when the asset is changed or deleted. - -Additionally, the smart CDN has a higher cache hit ratio as the origin server is shielded from asset requests that haven't changed when using different query strings in the URL. - -### Cache duration - -When Smart CDN is enabled, the asset is cached on the CDN for as long as possible. You can still control how long assets are stored in the browser using the [cacheControl](/docs/reference/javascript/storage-from-upload) option when uploading a file. Smart CDN caching works with all types of storage operations including signed URLs. - -When a file is updated or deleted, the CDN cache is automatically invalidated to reflect the change (including transformed images). It can take **up to 60 seconds** for the CDN cache to be invalidated as the asset metadata has to propagate across all the data-centers around the globe. - -When an asset is invalidated at the CDN level, browsers may not update its cache. - -If your asset is updated frequently, we recommend that you re-upload the new asset in a different key, this way you'll always have the latest changes available without waiting the propagation delay. If you expect your asset to be deleted, we recommend setting a low browser TTL value using the `cacheControl` option when using smart CDN caching, the default is 1 hour which generally is a good default. - -## Public vs Private Buckets - -Objects in public buckets do not require any Authorization to access objects. This leads to a better cache hit rate compared to private buckets. For private buckets, permissions for accessing each object is checked on a per user level. For example, if two different users access the same object in a private bucket from the same region, it results in a cache miss for both the users since they might have different security policies attached to them. On the other hand, if two different users access the same object in a public bucket from the same region, it results in a cache hit for the second user. - -## Debugging Cache Hits - -The [storage report](https://supabase.com/dashboard/project/_/reports/storage) gives a breakdown of your project's cache hit rate. - -The [Logs Explorer](https://supabase.com/dashboard/project/_/logs/explorer) can also be used to debug cache misses. - -The reporting date range depends on your plan's log retention. - -Cache hits can be determined via the `metadata.response.headers.cf_cache_status` key. Any value corresponding to either `HIT`, `STALE`, `REVALIDATED`, or `UPDATING` is considered a cache hit. -The following example query will show the top cache misses from the `edge_logs`: - -```sql -select - r.path as path, - r.search as search, - count(id) as count -from - edge_logs as f - cross join unnest(f.metadata) as m - cross join unnest(m.request) as r - cross join unnest(m.response) as res - cross join unnest(res.headers) as h -where - starts_with(r.path, '/storage/v1/object') - and r.method = 'GET' - and h.cf_cache_status in ('MISS', 'NONE/UNKNOWN', 'EXPIRED', 'BYPASS', 'DYNAMIC') -group by path, search -order by count desc -limit 50; -``` - -Try out this query in the Logs Explorer [here]("https://supabase.com/dashboard/project/_/logs/explorer?q=%0Aselect%0A++r.path+as+path%2C%0A++r.search+as+search%2C%0A++count%28id%29+as+count%0Afrom%0A++edge_logs+as+f%0A++cross+join+unnest%28f.metadata%29+as+m%0A++cross+join+unnest%28m.request%29+as+r%0A++cross+join+unnest%28m.response%29+as+res%0A++cross+join+unnest%28res.headers%29+as+h%0Awhere%0A++starts_with%28r.path%2C+%27%2Fstorage%2Fv1%2Fobject%27%29%0A++and+r.method+%3D+%27GET%27%0A++and+h.cf_cache_status+in+%28%27MISS%27%2C+%27NONE%2FUNKNOWN%27%2C+%27EXPIRED%27%2C+%27BYPASS%27%2C+%27DYNAMIC%27%29%0Agroup+by+path%2C+search%0Aorder+by+count+desc%0Alimit+50%3B"). - -Your cache hit ratio over time can then be determined using the following query: - -```sql -select - timestamp_trunc(timestamp, hour) as timestamp, - countif(h.cf_cache_status in ('HIT', 'STALE', 'REVALIDATED', 'UPDATING')) / count(f.id) as ratio -from - edge_logs as f - cross join unnest(f.metadata) as m - cross join unnest(m.request) as r - cross join unnest(m.response) as res - cross join unnest(res.headers) as h -where starts_with(r.path, '/storage/v1/object') and r.method = 'GET' -group by timestamp -order by timestamp desc; -``` - -Try out this query in the Logs Explorer [here]("https://supabase.com/dashboard/project/_/logs/explorer?q=%0Aselect%0A++timestamp_trunc%28timestamp%2C+hour%29+as+timestamp%2C%0A++countif%28h.cf_cache_status+in+%28%27HIT%27%2C+%27STALE%27%2C+%27REVALIDATED%27%2C+%27UPDATING%27%29%29+%2F+count%28f.id%29+as+ratio%0Afrom%0A++edge_logs+as+f%0A++cross+join+unnest%28f.metadata%29+as+m%0A++cross+join+unnest%28m.request%29+as+r%0A++cross+join+unnest%28m.response%29+as+res%0A++cross+join+unnest%28res.headers%29+as+h%0Awhere+starts_with%28r.path%2C+%27%2Fstorage%2Fv1%2Fobject%27%29+and+r.method+%3D+%27GET%27%0Agroup+by+timestamp%0Aorder+by+timestamp+desc%3B"). - -export const Page = ({ children }) => - -export default Page diff --git a/apps/docs/pages/guides/storage/cdn/fundamentals.mdx b/apps/docs/pages/guides/storage/cdn/fundamentals.mdx new file mode 100644 index 00000000000..010d7b161bc --- /dev/null +++ b/apps/docs/pages/guides/storage/cdn/fundamentals.mdx @@ -0,0 +1,41 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-cdn', + title: 'Storage CDN', + description: 'Learn how Supabase Storage caches objects with a CDN.', + sidebar_label: 'CDN', +} + +All assets uploaded to Supabase Storage are cached on a Content Delivery Network (CDN) to improve the latency for users all around the world. CDNs are a geographically distributed set of servers or **nodes** which cache content from an **origin server**. For Supabase Storage, the origin is the storage server running in the [same region as your project](https://supabase.com/dashboard/project/_/settings/general). Aside from performance, CDNs also help with security and availability by mitigating Distributed Denial of Service (DDoS) and other application attacks. + +### Example + +Let's walk through an example of how a CDN helps with performance. + +A new bucket is created for a Supabase project launched in Singapore. All requests to the Supabase Storage API are routed to the CDN first. + +A user from the United States requests an object and is routed to the U.S. CDN. At this point, that CDN node does not have the object in its cache and pings the origin server in Singapore. +![CDN cache miss](/docs/img/cdn-cache-miss.png) + +Another user, also in the United States, requests the same object and is served directly from the CDN cache in the United States instead of routing the request back to Singapore. +![CDN cache hit](/docs/img/cdn-cache-hit.png) + + + +Note that CDNs might still evict your object from their cache if it has not been requested for a while from a specific region. For example, if no user from United States requests your object, it will be removed from the CDN cache even if we set a very long cache control duration. + + + +The cache status of a particular request is sent in the `cf-cache-status` header. A cache status of `MISS` indicates that the CDN node did not have the object in its cache and had to ping the origin to get it. A cache status of `HIT` indicates that the object was sent directly from the CDN. + +### Public vs Private Buckets + +Objects in public buckets do not require any authorization to access objects. This leads to a better cache hit rate compared to private buckets. + +For private buckets, permissions for accessing each object is checked on a per user level. For example, if two different users access the same object in a private bucket from the same region, it results in a cache miss for both the users since they might have different security policies attached to them. +On the other hand, if two different users access the same object in a public bucket from the same region, it results in a cache hit for the second user. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/cdn/metrics.mdx b/apps/docs/pages/guides/storage/cdn/metrics.mdx new file mode 100644 index 00000000000..9257fbb32d3 --- /dev/null +++ b/apps/docs/pages/guides/storage/cdn/metrics.mdx @@ -0,0 +1,56 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-cdn', + title: 'Cache Metrics', + description: 'Learn how Supabase Storage caches objects with a CDN.', + sidebar_label: 'CDN', +} + +Cache hits can be determined via the `metadata.response.headers.cf_cache_status` key in our [Logs Explorer](/docs/guides/platform/logs#logs-explorer). Any value that corresponds to either `HIT`, `STALE`, `REVALIDATED`, or `UPDATING` is categorized as a cache hit. +The following example query will show the top cache misses from the `edge_logs`: + +```sql +select + r.path as path, + r.search as search, + count(id) as count +from + edge_logs as f + cross join unnest(f.metadata) as m + cross join unnest(m.request) as r + cross join unnest(m.response) as res + cross join unnest(res.headers) as h +where + starts_with(r.path, '/storage/v1/object') + and r.method = 'GET' + and h.cf_cache_status in ('MISS', 'NONE/UNKNOWN', 'EXPIRED', 'BYPASS', 'DYNAMIC') +group by path, search +order by count desc +limit 50; +``` + +Try out [this query](https://supabase.com/dashboard/project/_/logs/explorer?q=%0Aselect%0A++r.path+as+path%2C%0A++r.search+as+search%2C%0A++count%28id%29+as+count%0Afrom%0A++edge_logs+as+f%0A++cross+join+unnest%28f.metadata%29+as+m%0A++cross+join+unnest%28m.request%29+as+r%0A++cross+join+unnest%28m.response%29+as+res%0A++cross+join+unnest%28res.headers%29+as+h%0Awhere%0A++starts_with%28r.path%2C+%27%2Fstorage%2Fv1%2Fobject%27%29%0A++and+r.method+%3D+%27GET%27%0A++and+h.cf_cache_status+in+%28%27MISS%27%2C+%27NONE%2FUNKNOWN%27%2C+%27EXPIRED%27%2C+%27BYPASS%27%2C+%27DYNAMIC%27%29%0Agroup+by+path%2C+search%0Aorder+by+count+desc%0Alimit+50%3B) in the Logs Explorer. + +Your cache hit ratio over time can then be determined using the following query: + +```sql +select + timestamp_trunc(timestamp, hour) as timestamp, + countif(h.cf_cache_status in ('HIT', 'STALE', 'REVALIDATED', 'UPDATING')) / count(f.id) as ratio +from + edge_logs as f + cross join unnest(f.metadata) as m + cross join unnest(m.request) as r + cross join unnest(m.response) as res + cross join unnest(res.headers) as h +where starts_with(r.path, '/storage/v1/object') and r.method = 'GET' +group by timestamp +order by timestamp desc; +``` + +Try out [this query](https://supabase.com/dashboard/project/_/logs/explorer?q=%0Aselect%0A++timestamp_trunc%28timestamp%2C+hour%29+as+timestamp%2C%0A++countif%28h.cf_cache_status+in+%28%27HIT%27%2C+%27STALE%27%2C+%27REVALIDATED%27%2C+%27UPDATING%27%29%29+%2F+count%28f.id%29+as+ratio%0Afrom%0A++edge_logs+as+f%0A++cross+join+unnest%28f.metadata%29+as+m%0A++cross+join+unnest%28m.request%29+as+r%0A++cross+join+unnest%28m.response%29+as+res%0A++cross+join+unnest%28res.headers%29+as+h%0Awhere+starts_with%28r.path%2C+%27%2Fstorage%2Fv1%2Fobject%27%29+and+r.method+%3D+%27GET%27%0Agroup+by+timestamp%0Aorder+by+timestamp+desc%3B) in the Logs Explorer. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/cdn/smart-cdn.mdx b/apps/docs/pages/guides/storage/cdn/smart-cdn.mdx new file mode 100644 index 00000000000..9ec314f1b63 --- /dev/null +++ b/apps/docs/pages/guides/storage/cdn/smart-cdn.mdx @@ -0,0 +1,44 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-cdn', + title: 'Smart CDN', + description: 'Learn how Supabase Storage caches objects with a CDN.', + sidebar_label: 'CDN', +} + +With Smart CDN caching enabled, the asset metadata in your database is synchronized to the edge. This automatically revalidates the cache when the asset is changed or deleted. + +Moreover, the Smart CDN achieves a greater cache hit rate by shielding the origin server from asset requests that remain unchanged, even when different query strings are used in the URL. + + + +Smart CDN caching is automatically enabled for [Pro plan and above](https://supabase.com/pricing). + + + +## Cache duration + +When Smart CDN is enabled, the asset is cached on the CDN for as long as possible. You can still control how long assets are stored in the browser using the [cacheControl](/docs/reference/javascript/storage-from-upload) option when uploading a file. Smart CDN caching works with all types of storage operations including signed URLs. + +When a file is updated or deleted, the CDN cache is automatically invalidated to reflect the change (including transformed images). It can take **up to 60 seconds** for the CDN cache to be invalidated as the asset metadata has to propagate across all the data-centers around the globe. + +When an asset is invalidated at the CDN level, browsers may not update its cache. This is where cache eviction comes into play. + +## Cache Eviction + +Even when an asset is marked as invalidated at the CDN level, browsers may not refresh their cache for that asset. + +If you have assets that undergo frequent updates, it is advisable to upload the new asset to a different path. This approach ensures that you always have the most up-to-date asset accessible. + +If you anticipate that your asset might be deleted, it's advisable to set a shorter browser Time-to-Live (TTL) value using the `cacheControl` option. The default TTL is typically set to 1 hour, which is generally a reasonable default value. + +## Bypassing Cache + +If you need to ensure assets refresh directly from the origin server and bypass the cache, you can achieve this by adding a unique query string to the URL. + +For instance, you can use a URL like `/storage/v1/object/sign/profile-pictures/cat.jpg?version=1` with a long browser cache (e.g., 1 year). To update the picture, increment the version query parameter in the URL, like `/storage/v1/object/sign/profile-pictures/cat.jpg?version=2`. The CDN will recognize it as a new object and fetch the updated version from the origin. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/debugging/error-codes.mdx b/apps/docs/pages/guides/storage/debugging/error-codes.mdx new file mode 100644 index 00000000000..39406cb2af7 --- /dev/null +++ b/apps/docs/pages/guides/storage/debugging/error-codes.mdx @@ -0,0 +1,63 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-errors-codes', + title: 'Error Codes', + description: 'Supabase Error Codes', + sidebar_label: 'Debugging', +} + +Here's a list of the most common error codes and their potential resolutions: + +## 404 not_found + +Indicates that the resource is not found or you don't have the correct permission to access it +**Resolution:** + +- Add a RLS policy to grant permission to the resource. See our [Access Control docs](/docs/guides/storage/uploads/access-control) for more information. +- Ensure you include the user `Authorization` header +- Verify the object exists + +## 409 already_exists + +Indicates that the resource already exists. +**Resolution:** + +- Use the `upsert` functionality in order to overwrite the file. Find out more [here](/docs/guides/storage/uploads/standard-uploads#overwriting-files). + +## 403 unauthorized + +You don't have permission to action this request +**Resolution:** + +- Add RLS policy to grant permission. See our [Access Control docs](/docs/guides/storage/uploads/access-control) for more information. +- Ensure you include the user `Authorization` header + +## 429 Too many requests + +This problem typically arises when a large number of clients are concurrently interacting with the Storage service, and the pooler has reached its `max_clients` limit. + +**Resolution:** + +- Increase the max_clients limits of the pooler. +- Upgrade to a bigger project compute instance [here](https://supabase.com/dashboard/project/_/settings/addons). + +## 544 database_timeout + +This problem arises when a high number of clients are concurrently using the Storage service, and Postgres doesn't have enough available connections to efficiently handle requests to Storage. + +**Resolution:** + +- Increase the pool_size limits of the pooler. +- Upgrade to a bigger project compute instance [here](https://supabase.com/dashboard/project/_/settings/addons). + +## 500 internal_server_error + +This issue occurs where there is a unhandled error. +**Resolution:** + +- File a support ticket to Storage team [here](https://supabase.com/dashboard/support/new) + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/debugging/logs.mdx b/apps/docs/pages/guides/storage/debugging/logs.mdx new file mode 100644 index 00000000000..4165f9e0529 --- /dev/null +++ b/apps/docs/pages/guides/storage/debugging/logs.mdx @@ -0,0 +1,68 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-logs', + title: 'Logs', + description: 'Learn how to check Storage Logs', + sidebar_label: 'Debugging', +} + +Accessing the [Storage Logs](https://supabase.green/dashboard/project/__/logs/explorer?q=select+id%2C+storage_logs.timestamp%2C+event_message+from+storage_logs%0A++%0A++order+by+timestamp+desc%0A++limit+100%0A++) allows you to examine all incoming request logs to your Storage service. You can also filter logs and delve into specific aspects of your requests. + +### Common Log Queries + +#### Filter by status 5XX error + +```sql +select id, storage_logs.timestamp, event_message, r.statusCode, e.message as errorMessage e.raw as rawError + from storage_logs + cross join unnest(metadata) as m + cross join unnest(m.res) as r + cross join unnest(m.error) as e + where r.statusCode >= 500 + order by timestamp desc + limit 100 +``` + +#### Filter by status 4XX error + +```sql +select id, storage_logs.timestamp, event_message, r.statusCode, e.message as errorMessage e.raw as rawError + from storage_logs + cross join unnest(metadata) as m + cross join unnest(m.res) as r + cross join unnest(m.error) as e + where r.statusCode >= 400 and r.statusCode < 500 + order by timestamp desc + limit 100 +``` + +#### Filter by Method + +```sql +select id, storage_logs.timestamp, event_message, r.method +from + storage_logs + cross join unnest(metadata) as m + cross join unnest(m.req) as r +where r.method in ("POST") +order by timestamp desc +limit 100; +``` + +#### Filter by IP Address + +```sql +select id, storage_logs.timestamp, event_message, r.remoteAddress +from + storage_logs + cross join unnest(metadata) as m + cross join unnest(m.req) as r +where r.remoteAddress in ("IP_ADDRESS") +order by timestamp desc +limit 100; +``` + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/production/scaling.mdx b/apps/docs/pages/guides/storage/production/scaling.mdx new file mode 100644 index 00000000000..099a4374393 --- /dev/null +++ b/apps/docs/pages/guides/storage/production/scaling.mdx @@ -0,0 +1,92 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-schema-optimisations', + title: 'Storage Optimisations', + description: 'Scaling Storage', + subtitle: 'Scaling Storage', + sidebar_label: 'Schema', +} + +Here are some optimisations that you can consider to improve performance and reduce costs as you start scaling Storage. + +## Egress + +If your project has high egress, these optimizations can help reducing it. + +#### Resize Images + +Images typically make up most of your egress. By keeping them as small as possible, you can cut down on egress and boost your application's performance. You can take advantage of our [Image Transformation](/docs/guides/storage/serving/image-transformations) service to optimize any image on the fly. + +#### Set a high cache-control value + +Using the browser cache can effectively lower your egress since the asset remains stored in the user's browser after the initial download. Setting a high `cache-control` value ensures the asset stays in the user's browser for an extended period, decreasing the need to download it from the server repeatedly. Read more [here](/docs/guides/storage/cdn/smart-cdn#cache-duration) + +#### Limit the upload size + +You have the option to set a maximum upload size for your bucket. Doing this can prevent users from uploading and then downloading excessively large files. You can control the maximum file size by configuring this option at the [bucket level](/docs/guides/storage/buckets/creating-buckets). + +## Optimize Listing Objects + +Once you have a substantial number of objects, you might observe that the `supabase.storage.list()` method starts to slow down. This occurs because the endpoint is quite generic and attempts to retrieve both folders and objects in a single query. While this approach is very useful for building features like the Storage viewer on the Supabase dashboard, it can impact performance with a large number of objects. + +If your application don't need the entire hierarchy computed you can speed up drastically the query execution for listing your objects by creating a Postgres function as following: + +```sql +create or replace function list_objects( + bucketid text, + prefix text, + limits int default 100, + offsets int default 0 +) returns table ( + name text, + id uuid, + updated_at timestamptz, + created_at timestamptz, + last_accessed_at timestamptz, + metadata jsonb +) as $$ +begin + return query SELECT + objects.name, + objects.id, + objects.updated_at, + objects.created_at, + objects.last_accessed_at, + objects.metadata + FROM storage.objects + WHERE objects.name like prefix || '%' + AND bucket_id = bucketid + ORDER BY name ASC + LIMIT limits + OFFSET offsets; +end; +$$ language plpgsql stable; +``` + +You can then use the your Postgres function as following: + +Using SQL: + +```sql +select * from list_objects('bucket_id', '', 100, 0); +``` + +Using the SDK: + +```js +const { data, error } = await supabase.rpc('list_objects', { + bucketid: 'yourbucket', + prefix: '', + limit: 100, + offset: 0, +}) +``` + +## Optimizing RLS + +When creating RLS policies against the storage tables you can add indexes to the interested columns to speed up the lookup + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/schema/design.mdx b/apps/docs/pages/guides/storage/schema/design.mdx new file mode 100644 index 00000000000..86cdedf4c5a --- /dev/null +++ b/apps/docs/pages/guides/storage/schema/design.mdx @@ -0,0 +1,34 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-schema-design', + title: 'The Storage Schema', + description: 'Learn about the storage schema', + subtitle: 'Learn about the storage schema', + sidebar_label: 'Schema', +} + +Storage uses Postgres to store metadata regarding your buckets and objects. Users can use RLS (Row-Level Security) policies for access control. This data is stored in a dedicated schema within your project called `storage`. + + +When working with SQL, it's crucial to consider all records in Storage tables as read-only. All operations, including uploading, copying, moving, and deleting, should **exclusively go through the API**. + +This is important because the storage schema only stores the metadata and the actual objects are stored in a provider like S3. Deleting the metadata doesn't remove the object in the underlying storage provider. This results in your object being inaccessible, but you'll still be billed for it. + + + +Here is the schema that represents the Storage service: + +Storage schema design + +You have the option to query this table directly to retrieve information about your files in Storage without the need to go through our API. + +## Modifying the Schema + +We strongly recommend refraining from making any alterations to the `storage` schema and treating it as read-only. This approach is important because any modifications to the schema on your end could potentially clash with our future updates, leading to downtime. + +However, we encourage you to add custom indexes as they can significantly improve the performance of the RLS policies you create for enforcing access control. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/schema/helper-functions.mdx b/apps/docs/pages/guides/storage/schema/helper-functions.mdx new file mode 100644 index 00000000000..3c0f7a2f30b --- /dev/null +++ b/apps/docs/pages/guides/storage/schema/helper-functions.mdx @@ -0,0 +1,69 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-schema', + title: 'Storage Helper Functions', + description: 'Learn the storage schema', + subtitle: 'Learn the storage schema', + sidebar_label: 'Schema', +} + +Supabase Storage provides SQL helper functions which you can use to write RLS policies. + +### `storage.filename()` + +Returns the name of a file. For example, if your file is stored in `public/subfolder/avatar.png` it would return: `'avatar.png'` + +**Usage** + +This example demonstrates how you would allow any user to download a file called `favicon.ico`: + +```sql +create policy "Allow authenticated uploads" +on storage.objects +for select +to public +using ( + storage.filename(name) = 'favicon.ico' +); +``` + +### `storage.foldername()` + +Returns an array path, with all of the subfolders that a file belongs to. For example, if your file is stored in `public/subfolder/avatar.png` it would return: `[ 'public', 'subfolder' ]` + +**Usage** + +This example demonstrates how you would allow authenticated users to upload files to a folder called `private`: + +```sql +create policy "Allow authenticated uploads" +on storage.objects +for insert +to authenticated +with check ( + storage.foldername(name)[1] = 'private' +); +``` + +### `storage.extension()` + +Returns the extension of a file. For example, if your file is stored in `public/subfolder/avatar.png` it would return: `'png'` + +**Usage** + +This example demonstrates how you would allow restrict uploads to only PNG files inside a bucket called `cats`: + +```sql +create policy "Only allow PNG uploads" +on storage.objects +for insert +to authenticated +with check ( + bucket_id = 'cats' and storage.extension(name) = 'png' +); +``` + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/security/access-control.mdx b/apps/docs/pages/guides/storage/security/access-control.mdx new file mode 100644 index 00000000000..5ab691f8363 --- /dev/null +++ b/apps/docs/pages/guides/storage/security/access-control.mdx @@ -0,0 +1,109 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-access-control', + title: 'Storage Access Control', + description: 'Learn how to restrict Supabase file uploads.', + sidebar_label: 'Uploads', + tocVideo: '4ERX__Y908k', +} + +Supabase Storage is designed to work perfectly with Postgres [Row Level Security](https://supabase.com/docs/guides/database/postgres/row-level-security) (RLS). + +You can use RLS to create [Security Access Policies](https://www.postgresql.org/docs/current/sql-createpolicy.html) that are incredibly powerful and flexible, allowing you to restrict access based on your business needs. + +## Access Policies + +By default Storage does not allow any uploads to buckets without RLS policies. You selectively allow certain operations by creating RLS policies on the `storage.objects` table. + +You can find the documentation for the storage schema [here](/docs/guides/storage/schema/design) , and to simplify the process of crafting your policies, you can utilize these [helper functions](/docs/guides/storage/schema/helper-functions) . + + + +The RLS policies required for different operations are documented [here](/docs/reference/javascript/storage-createbucket) + + + +For example, the only RLS policy required for [uploading](/docs/reference/javascript/storage-from-upload) objects is to grant the `INSERT` permission to the `storage.objects` table. + +To allow overwriting files using the `upsert` functionality you will need to additionally grant `SELECT` and `UPDATE` permissions. + +## Policy Examples + +An easy way to get started would be to create RLS policies for `SELECT`, `INSERT`, `UPDATE`, `DELETE` operations and restrict the policies to meet your security requirements. For example, one can start with the following `INSERT` policy: + +```sql +create policy "policy_name" +ON storage.objects +for insert with check ( + true +); +``` + +and modify it to only allow authenticated users to upload assets to a specific bucket by changing it to: + +```sql +create policy "policy_name" +on storage.objects for insert to authenticated with check ( + -- restrict bucket + bucket_id = 'my_bucket_id' +); +``` + +This example demonstrates how you would allow authenticated users to upload files to a folder called `private` inside `my_bucket_id`: + +```sql +create policy "Allow authenticated uploads" +on storage.objects +for insert +to authenticated +with check ( + bucket_id = 'my_bucket_id' and + storage.foldername(name)[1] = 'private' +); +``` + +This example demonstrates how you would allow authenticated users to upload files to a folder called with their `users.id` inside `my_bucket_id`: + +```sql +create policy "Allow authenticated uploads" +on storage.objects +for insert +to authenticated +with check ( + bucket_id = 'my_bucket_id' and + storage.foldername(name)[1] = auth.uid() +); +``` + +Allow a user to access a file that was previously uploaded by the same user: + +```sql +create policy "Individual user Access" +on storage.objects for select +to authenticated +using ( auth.uid() = owner_id ); +``` + +--- + +{/* Finish with a video. This also appears in the Sidebar via the "tocVideo" metadata */} + +
+ +
+ +## Bypassing access controls + +If you exclusively use Storage from trusted clients, such as your own servers, and need to bypass the RLS policies, you can use the `service key` in the `Authorization` header. Service keys entirely bypass RLS policies, granting you unrestricted access to all Storage APIs. + +Remember you should not share the service key publicly. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/serving/downloads.mdx b/apps/docs/pages/guides/storage/serving/downloads.mdx new file mode 100644 index 00000000000..a3a80b507fb --- /dev/null +++ b/apps/docs/pages/guides/storage/serving/downloads.mdx @@ -0,0 +1,59 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-image-transformations', + title: 'Serving assets from Storage', + description: 'Serving assets from Storage', + subtitle: 'Serving assets from Storage', + sidebar_label: 'Serving assets', + tocVideo: 'dLqSmxX3r7I', +} + +## Public Buckets + +As mentioned in the [Buckets Fundamentals](/docs/guides/storage/buckets/fundamentals) all files uploaded in a public bucket are publicly accessible and benefit a high CDN cache HIT ratio. + +You can access them by using this conventional URL: + +``` +https://[project_id].supabase.co/storage/v1/public/[bucket]/[asset-name] +``` + +You can also use the Supabase SDK `getPublicUrl` to generate this url for you + +```js +const publicUrl = supabase.storage.from('bucket').getPublicUrl('filePath.jpg') +``` + +### Downloading + +If you want the browser to start an automatic download of the asset instead of trying serving it, you can add the `?download` querystring parameter. + +By default it will use the asset name to save the file on disk. You can optionally pass a custom name to the `download` parameter as following: `?download=customname.jpg` + +## Private buckets + +Assets stored in a non-public bucket are considered private and are not accessible via a public url like the public buckets. + +You can access them only by: + +- Signing a time limited URL on the Server, for example with Edge Functions. +- with a GET request the url `https://[project_id].supabase.co/storage/v1/authenticated/[bucket]/[asset-name]` and the user Authorization header + +### Signing URLs + +You can sign a time-limited URL that you can share to your users by invoking the `createSignedUrl` method on the SDK. + +```js +const { data, error } = supabase.storage + .from('bucket') + .createSignedUrl('private-document.pdf', 3600) + +if (data) { + console.log(data.signedUrl) +} +``` + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/image-transformations.mdx b/apps/docs/pages/guides/storage/serving/image-transformations.mdx similarity index 88% rename from apps/docs/pages/guides/storage/image-transformations.mdx rename to apps/docs/pages/guides/storage/serving/image-transformations.mdx index cd01774cd72..bf31e12e78a 100644 --- a/apps/docs/pages/guides/storage/image-transformations.mdx +++ b/apps/docs/pages/guides/storage/serving/image-transformations.mdx @@ -9,7 +9,7 @@ export const meta = { tocVideo: 'dLqSmxX3r7I', } -Supabase Storage offers the functionality to transform and resize images dynamically. Any image stored in your buckets can be transformed and optimized for fast delivery. +Supabase Storage offers the functionality to optimize and resize images on the fly. Any image stored in your buckets can be transformed and optimized for fast delivery. @@ -28,7 +28,7 @@ Image Resizing is currently enabled for [Pro plan and above](https://supabase.co > -You can pass a `transform` option to the functions you are currently using to interact with your objects. This returns the public URL that serves the resized image. +Our client libraries methods like `getPublicUrl` and `createSignedUrl` support the `transform` option. This returns the URL that serves the transformed image. ```ts supabase.storage.from('bucket').getPublicUrl('image.jpg', { @@ -57,7 +57,7 @@ An example URL could look like this: ## Signing URLs with transformation options -To share a transformed image for a fixed amount of time, provide the transform options when you create the signed URL: +To share a transformed image in a private bucket for a fixed amount of time, provide the transform option when you create the signed URL: -The transformation options are embedded into the token—they cannot be changed once signed. +The transformation options are embedded into the token attached to the URL — they cannot be changed once signed. ## Downloading images @@ -133,7 +133,7 @@ supabase.storage["bucket"].downloadAuthenticatedTo("image.jpg", file) { ## Automatic Image Optimisation (WebP) -When using the image transformation API we will automatically find the best format supported by the browser and return that to the client, without any code change. For instance, if you use Chrome when viewing a jpeg image and using transformation options, you'll see that the content-type returned is `webp`. +When using the image transformation API, Storage will automatically find the best format supported by the client and return that to the client, without any code change. For instance, if you use Chrome when viewing a jpeg image and using transformation options, you'll see that images are automatically optimized as `webp` images. As a result, this will lower the bandwidth that you send to your users and your application will load much faster. @@ -188,7 +188,7 @@ supabase.storage["bucket"].downloadAuthenticatedTo("image.jpg", file) { ## NextJS Loader -You can use Supabase Image Transformation to optimise your NextJS images using a custom [Loader](https://nextjs.org/docs/api-reference/next/image#loader-configuration). +You can use Supabase Image Transformation to optimize your NextJS images using a custom [Loader](https://nextjs.org/docs/api-reference/next/image#loader-configuration). To get started, create a `supabase-image-loader.js` file in your NextJS project which exports a default function: @@ -307,7 +307,7 @@ supabase.storage["bucket"].downloadAuthenticatedTo("image.jpg", file) { ## Self Hosting -Our solution to image resizing and optimisation can be self-hosted as with any other Supabase product. Under the hood we use the awesome [Imgproxy](https://imgproxy.net/) +Our solution to image resizing and optimisation can be self-hosted as with any other Supabase product. Under the hood we use [Imgproxy](https://imgproxy.net/) #### Imgproxy Configuration: diff --git a/apps/docs/pages/guides/storage/storage-sample.mdx b/apps/docs/pages/guides/storage/storage-sample.mdx deleted file mode 100644 index 0c0e277b3fc..00000000000 --- a/apps/docs/pages/guides/storage/storage-sample.mdx +++ /dev/null @@ -1,11 +0,0 @@ -import Layout from '~/layouts/DefaultGuideLayout' - -export const meta = { - id: 'storage-sample', - title: 'Storage Sample Doc', - description: 'Storage Sample Doc', -} - -## Description - -Sample... diff --git a/apps/docs/pages/guides/storage/uploads.mdx b/apps/docs/pages/guides/storage/uploads.mdx deleted file mode 100644 index d287d6386a7..00000000000 --- a/apps/docs/pages/guides/storage/uploads.mdx +++ /dev/null @@ -1,242 +0,0 @@ -import Layout from '~/layouts/DefaultGuideLayout' - -export const meta = { - id: 'storage-uploads', - title: 'Storage Uploads', - description: 'Learn how to upload files to Supabase Storage.', - subtitle: 'Learn how to upload files to Supabase Storage.', - sidebar_label: 'Uploads', -} - -Supabase Storage provides two methods for uploading files: - -- Standard Uploads -- Resumable Uploads - -## Standard Upload - -The standard file upload method is ideal for small files that are not larger than 6MB. - -It uses the traditional `multipart/form-data` format and is simple to implement using the supabase-js SDK. Here's an example of how to upload a file using the standard upload method: - - - -Though you can upload up to 5GB files using the standard upload method, we recommend use [TUS Resumable Upload](#resumable-upload) for uploading files greater than 6MB in size for better reliability. - - - - - - -```javascript -import { createClient } from '@supabase/supabase-js' - -// Create Supabase client -const supabase = createClient('your_project_url', 'your_supabase_api_key') - -// Upload file using standard upload -async function uploadFile(file) { - const { data, error } = await supabase.storage.from('bucket_name').upload('file_path', file) - if (error) { - // Handle error - } else { - // Handle success - } -} -``` - - - - -```kotlin -val supabase = createSupabaseClient(supabaseUrl, supabaseKey) { - install(Storage) -} - -suspend fun uploadData(bytes: ByteArray) { - supabase.storage["bucket_name"].upload("file_path", bytes) -} - -//Or on JVM/Android: (This will stream the data from the file to supabase) -suspend fun uploadFile(file: File) { - supabase.storage["bucket_name"].upload("file_path", file) -} -``` - - - - -## Resumable Upload - - - -Resumable upload is in **Beta**. We are rolling this feature gradually, please contact us if you want to be prioritized. - - - -The Resumable upload method is recommended for uploading large files that may exceed 6MB in size or for scenarios where network stability is a concern or if you simply want to have a progress bar for your uploads. - -Supabase Storage implements the [TUS protocol](https://tus.io/) to enable resumable uploads. TUS stands for The Upload Server and is an open protocol for supporting resumable uploads. The protocol allows the upload process to be resumed from where it left off in case of interruptions. This method can be implemented using the tus-js-client library, or other client-side libraries like [Uppy-js](https://uppy.io/docs/tus/) that support the TUS protocol. - - - - -Here's an example of how to upload a file using `tus-js-client`: - -```javascript -const tus = require('tus-js-client') - -const projectId = '' - -async function uploadFile(bucketName, fileName, file) { - const { data: session } = await supabase.auth.session() - - return new Promise((resolve, reject) => { - var upload = new tus.Upload(file, { - endpoint: `https://${projectId}.supabase.co/storage/v1/upload/resumable`, - retryDelays: [0, 3000, 5000, 10000, 20000], - headers: { - authorization: `Bearer ${session.access_token}`, - 'x-upsert': 'true', // optionally set upsert to true to overwrite existing files - }, - uploadDataDuringCreation: true, - removeFingerprintOnSuccess: true, // Important if you want to allow re-uploading the same file https://github.com/tus/tus-js-client/blob/main/docs/api.md#removefingerprintonsuccess - metadata: { - bucketName: bucketName, - objectName: fileName, - contentType: 'image/png', - cacheControl: 3600, - }, - chunkSize: 6 * 1024 * 1024, // NOTE: it must be set to 6MB (for now) do not change it - onError: function (error) { - console.log('Failed because: ' + error) - reject(error) - }, - onProgress: function (bytesUploaded, bytesTotal) { - var percentage = ((bytesUploaded / bytesTotal) * 100).toFixed(2) - console.log(bytesUploaded, bytesTotal, percentage + '%') - }, - onSuccess: function () { - // console.log(upload) - console.log('Download %s from %s', upload.file.name, upload.url) - resolve() - }, - }) - - // Check if there are any previous uploads to continue. - return upload.findPreviousUploads().then(function (previousUploads) { - // Found previous uploads so we select the first one. - if (previousUploads.length) { - upload.resumeFromPreviousUpload(previousUploads[0]) - } - - // Start the upload - upload.start() - }) - }) -} -``` - - - - -Kotlin supports resumable uploads natively for all targets: - -```kotlin -//Or on JVM/Android: (This will stream the data from the file to supabase) -suspend fun uploadFile(file: File) { - val upload: ResumableUpload = supabase.storage["bucket_name"].resumable.createOrContinueUpload("file_path", file) - - upload.stateFlow - .onEach { - println(it.progress) - } - .launchIn(yourCoroutineScope) - - upload.startOrResumeUploading() -} - -//On other platforms you might have to give the bytes directly and specify a source if you want to continue it alter: -suspend fun uploadData(bytes: ByteArray) { - val upload: ResumableUpload = supabase.storage["bucket_name"].resumable.createOrContinueUpload(bytes, "source", "file_path") - - upload.stateFlow - .onEach { - println(it.progress) - } - .launchIn(yourCoroutineScope) - - upload.startOrResumeUploading() -} -``` - - - - -### Upload URL - -When uploading using the resumable upload endpoint, the TUS server creates a unique URL for each upload, even for multiple uploads to the same path. All chunks will be uploaded to this URL using the `PATCH` method. - -This URL will be valid for **up to 24 hours**. If the upload is not completed within 24 hours, the URL will expire and you'll need to start the upload again. The TUS client library will automatically create a new URL if the previous one expires. - -### Concurrency - -When two or more clients try to upload to the same Upload URL only one of them will succeed. The other clients will receive a `409 Conflict` error. Only 1 client can upload to the same Upload URL at a time which prevents data corruption. - - - -We do not yet support checksum validation for the uploaded chunks. This means if a client changes the file mid way through the upload, the final upload will be an amalgamation of both the files. This has to be done intentionally by the client and is unlikely to happen in normal circumstances. - - - -When two or more clients upload a file to the same path using different upload URLs, the first client to complete the upload will succeed and the other clients will receive a `409 Conflict` error. - -If you provide the `x-upsert` header the last client to complete the upload will succeed instead. - -### UppyJS Example - -You can check a full example using UppyJS [Here](https://github.com/supabase/supabase/tree/master/examples/storage/resumable-upload-uppy) - -Framework integration for UppyJS: - -- [React](https://uppy.io/docs/react/) -- [Svelte](https://uppy.io/docs/svelte/) -- [Vue](https://uppy.io/docs/vue/) -- [Angular](https://uppy.io/docs/angular/) - -## Overwriting Files - -When uploading a file to a path that already exists, the default behavior is to return a `409 Conflict` error. -If you want to overwrite a file on a specific path you can set the `x-upsert` header to `true`. - -We do advise against overwriting files when possible, as the CDN will take sometime to propagate the changes to all the edge nodes leading to stale content. -Uploading a file to a new path is the recommended way to avoid propagation delays and stale content. - -If you want to know more about our CDN, check the [CDN](/docs/guides/storage/cdn) guide. - -## Access Control with RLS Policies - -Both the standard file upload and TUS resumable file upload methods in Supabase Storage support Row-Level Security (RLS) policies. RLS allows you to define fine-grained access control rules to restrict access to files based on user roles, permissions, or other criteria. This ensures that your files are secure and accessible only to authorized users. - -For more information on RLS policies, see the [Storage Access Control](/docs/guides/storage/access-control) guide. - -## Conclusion - -Supabase Storage provides multiple options for uploading files, including standard file upload and TUS resumable file upload, both of which use RLS policies for access control. -Additionally, there are client-side libraries like Uppy-js that make it easy to implement TUS uploads in your application. Choose the upload method that best fits your needs based on file size, network stability, and other requirements. - -export const Page = ({ children }) => - -export default Page diff --git a/apps/docs/pages/guides/storage/uploads/file-limits.mdx b/apps/docs/pages/guides/storage/uploads/file-limits.mdx new file mode 100644 index 00000000000..c902964c542 --- /dev/null +++ b/apps/docs/pages/guides/storage/uploads/file-limits.mdx @@ -0,0 +1,41 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'storage-file-limits', + title: 'Limits', + description: 'Learn how to increase Supabase file limits.', + sidebar_label: 'Uploads', +} + +You can customize the Max file size for file uploads. + +## Global File Size + +You can set the max file size across all your buckets by setting this global value in the dashboard [here](https://supabase.com/dashboard/project/_/settings/storage). + +For Free projects the limit cannot exceed 50MB. On the Pro Plan and above, you can set this value to up to 5GB. + +| Plan | Max File Size Limit | +| ---------- | ------------------- | +| Free | 50MB | +| Pro | 5GB | +| Team | 5GB | +| Enterprise | 5GB | + +If you need more than 5GB please [contact us](https://supabase.com/dashboard/support/new). + +Remember, this option is a global limit, which applies to all your buckets. +You can additionally specify the max file size on a per [bucket level](/docs/guides/storage/buckets/creating-buckets#restricting-uploads) but it cannot be higher than this global limit. + +It is a good practice to have the global limit set to the highest possible file size that your application accepts, and apply per bucket limits. + +## Per Bucket Restrictions + +You can have different restrictions on a per bucket level. +You are able to restrict the file types (eg. `pdf`, `images`, `videos`) along with the max file size which should be lower then the global limit. + +To apply these limit on a bucket level see [Creating Bucket](/docs/guides/storage/buckets/creating-buckets#restricting-uploads) + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/uploads/resumable-uploads.mdx b/apps/docs/pages/guides/storage/uploads/resumable-uploads.mdx new file mode 100644 index 00000000000..f4394b7dfb7 --- /dev/null +++ b/apps/docs/pages/guides/storage/uploads/resumable-uploads.mdx @@ -0,0 +1,161 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'resumable-uploads', + title: 'Resumable Uploads', + description: 'Learn how to upload files to Supabase Storage.', + subtitle: 'Learn how to upload files to Supabase Storage.', + sidebar_label: 'Uploads', +} + + + +Resumable upload is in **Beta**. We are rolling this feature gradually, please contact us if you want to be prioritized. + + + +The resumable upload method is recommended when: + +- Uploading large files that may exceed 6MB in size +- Network stability is a concern +- You want to have progress events for your uploads + +Supabase Storage implements the [TUS protocol](https://tus.io/) to enable resumable uploads. TUS stands for The Upload Server and is an open protocol for supporting resumable uploads. The protocol allows the upload process to be resumed from where it left off in case of interruptions. This method can be implemented using the [tus-js-client](https://github.com/tus/tus-js-client) library, or other client-side libraries like [Uppy-js](https://uppy.io/docs/tus/) that support the TUS protocol. + + + + + Here's an example of how to upload a file using `tus-js-client`: + + ```javascript + const tus = require('tus-js-client') + + const projectId = '' + + async function uploadFile(bucketName, fileName, file) { + const { data: session } = await supabase.auth.session() + + return new Promise((resolve, reject) => { + var upload = new tus.Upload(file, { + endpoint: `https://${projectId}.supabase.co/storage/v1/upload/resumable`, + retryDelays: [0, 3000, 5000, 10000, 20000], + headers: { + authorization: `Bearer ${session.access_token}`, + 'x-upsert': 'true', // optionally set upsert to true to overwrite existing files + }, + uploadDataDuringCreation: true, + removeFingerprintOnSuccess: true, // Important if you want to allow re-uploading the same file https://github.com/tus/tus-js-client/blob/main/docs/api.md#removefingerprintonsuccess + metadata: { + bucketName: bucketName, + objectName: fileName, + contentType: 'image/png', + cacheControl: 3600, + }, + chunkSize: 6 * 1024 * 1024, // NOTE: it must be set to 6MB (for now) do not change it + onError: function (error) { + console.log('Failed because: ' + error) + reject(error) + }, + onProgress: function (bytesUploaded, bytesTotal) { + var percentage = ((bytesUploaded / bytesTotal) * 100).toFixed(2) + console.log(bytesUploaded, bytesTotal, percentage + '%') + }, + onSuccess: function () { + console.log('Download %s from %s', upload.file.name, upload.url) + resolve() + }, + }) + + + // Check if there are any previous uploads to continue. + return upload.findPreviousUploads().then(function (previousUploads) { + // Found previous uploads so we select the first one. + if (previousUploads.length) { + upload.resumeFromPreviousUpload(previousUploads[0]) + } + + // Start the upload + upload.start() + }) + }) + } + ``` + + + + + Kotlin supports resumable uploads natively for all targets: + + ```kotlin + suspend fun uploadFile(file: File) { + val upload: ResumableUpload = supabase.storage["bucket_name"] + .resumable.createOrContinueUpload("file_path", file) + upload.stateFlow + .onEach { + println(it.progress) + } + .launchIn(yourCoroutineScope) + upload.startOrResumeUploading() + } + + // On other platforms you might have to give the bytes directly and specify a source if you want to continue it later: + suspend fun uploadData(bytes: ByteArray) { + val upload: ResumableUpload = supabase.storage["bucket_name"] + .resumable.createOrContinueUpload(bytes, "source", "file_path") + + upload.stateFlow + .onEach { + println(it.progress) + } + .launchIn(yourCoroutineScope) + upload.startOrResumeUploading() + } + ``` + + + + +### Upload URL + +When uploading using the resumable upload endpoint, the storage server creates a unique URL for each upload, even for multiple uploads to the same path. All chunks will be uploaded to this URL using the `PATCH` method. + +This unique upload URL will be valid for **up to 24 hours**. If the upload is not completed within 24 hours, the URL will expire and you'll need to start the upload again. TUS client libraries typically create a new URL if the previous one expires. + +### Concurrency + +When two or more clients upload to the same upload URL only one of them will succeed. The other clients will receive a `409 Conflict` error. Only 1 client can upload to the same upload URL at a time which prevents data corruption. + +When two or more clients upload a file to the same path using different upload URLs, the first client to complete the upload will succeed and the other clients will receive a `409 Conflict` error. + +If you provide the `x-upsert` header the last client to complete the upload will succeed instead. + +### UppyJS Example + +You can check a [full example using UppyJS](https://github.com/supabase/supabase/tree/master/examples/storage/resumable-upload-uppy). + +UppyJS has integrations with different frameworks: + +- [React](https://uppy.io/docs/react/) +- [Svelte](https://uppy.io/docs/svelte/) +- [Vue](https://uppy.io/docs/vue/) +- [Angular](https://uppy.io/docs/angular/) + +## Overwriting Files + +When uploading a file to a path that already exists, the default behavior is to return a `400 Asset Already Exists` error. +If you want to overwrite a file on a specific path you can set the `x-upsert` header to `true`. + +We do advise against overwriting files when possible, as the CDN will take some time to propagate the changes to all the edge nodes leading to stale content. +Uploading a file to a new path is the recommended way to avoid propagation delays and stale content. + +To learn more, see the [CDN](/docs/guides/storage/cdn/fundamentals) guide. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/pages/guides/storage/uploads/standard-uploads.mdx b/apps/docs/pages/guides/storage/uploads/standard-uploads.mdx new file mode 100644 index 00000000000..64061f54891 --- /dev/null +++ b/apps/docs/pages/guides/storage/uploads/standard-uploads.mdx @@ -0,0 +1,131 @@ +import Layout from '~/layouts/DefaultGuideLayout' + +export const meta = { + id: 'standard-uploads', + title: 'Standard Uploads', + description: 'Learn how to upload files to Supabase Storage.', + subtitle: 'Learn how to upload files to Supabase Storage.', + sidebar_label: 'Uploads', +} + +## Uploading + +The standard file upload method is ideal for small files that are not larger than 6MB. + +It uses the traditional `multipart/form-data` format and is simple to implement using the supabase-js SDK. Here's an example of how to upload a file using the standard upload method: + + + +Though you can upload up to 5GB files using the standard upload method, we recommend using [TUS Resumable Upload](/docs/guides/storage/uploads/resumable-uploads) for uploading files greater than 6MB in size for better reliability. + + + + + + +```javascript +import { createClient } from '@supabase/supabase-js' + +// Create Supabase client +const supabase = createClient('your_project_url', 'your_supabase_api_key') + +// Upload file using standard upload +async function uploadFile(file) { + const { data, error } = await supabase.storage.from('bucket_name').upload('file_path', file) + if (error) { + // Handle error + } else { + // Handle success + } +} +``` + + + + +```kotlin +val supabase = createSupabaseClient(supabaseUrl, supabaseKey) { + install(Storage) +} + +suspend fun uploadData(bytes: ByteArray) { + supabase.storage["bucket_name"].upload("file_path", bytes) +} + +//Or on JVM/Android: (This will stream the data from the file to supabase) +suspend fun uploadFile(file: File) { + supabase.storage["bucket_name"].upload("file_path", file) +} +``` + + + + +## Overwriting Files + +When uploading a file to a path that already exists, the default behavior is to return a `400 Asset Already Exists` error. +If you want to overwrite a file on a specific path you can set the `upsert` options to `true` or using the `x-upsert` header. + + + + +```javascript +// Create Supabase client +const supabase = createClient('your_project_url', 'your_supabase_api_key') + +await supabase.storage.from('bucket_name').upload('file_path', file, { + upsert: true, +}) +``` + + + + +We do advise against overwriting files when possible, as our Content Delivery Network will take sometime to propagate the changes to all the edge nodes leading to stale content. +Uploading a file to a new path is the recommended way to avoid propagation delays and stale content. + +## Content Type + +By default, Storage will assume the content type of an asset from the file extension. If you want to specify the content type for your asset simply pass the `contentType` option during upload. + + + + +```javascript +// Create Supabase client +const supabase = createClient('your_project_url', 'your_supabase_api_key') + +await supabase.storage.from('bucket_name').upload('file_path', file, { + contentType: 'image/jpeg', +}) +``` + + + + +## Concurrency + +When two or more clients upload a file to the same path, the first client to complete the upload will succeed and the other clients will receive a `400 Asset Already Exists` error. +If you provide the `x-upsert` header the last client to complete the upload will succeed instead. + +export const Page = ({ children }) => + +export default Page diff --git a/apps/docs/public/img/storage/schema-design.png b/apps/docs/public/img/storage/schema-design.png new file mode 100644 index 00000000000..79401732ce2 Binary files /dev/null and b/apps/docs/public/img/storage/schema-design.png differ diff --git a/apps/docs/public/sitemap.xml b/apps/docs/public/sitemap.xml index 2632f9d1b6a..7d6d2734095 100644 --- a/apps/docs/public/sitemap.xml +++ b/apps/docs/public/sitemap.xml @@ -103,7 +103,6 @@ -<<<<<<< HEAD https://supabase.com/docs/guides/ai/choosing-compute-addon weekly 0.5 @@ -152,124 +151,7 @@ - https://supabase.com/docs/guides/ai/structured-unstructured - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/vecs-python-client - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/vector-columns - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/vector-indexes -======= - https://supabase.com/docs/guides/api/api-keys ->>>>>>> @{-1} - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/customizing-email-templates - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/getting-started - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/local-development - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/managing-config - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/managing-environments - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/seeding-your-database - weekly - 0.5 - - - - https://supabase.com/docs/guides/cli/testing-and-linting - weekly - 0.5 - - - - https://supabase.com/docs/guides/api/using-custom-schemas - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/choosing-compute-addon - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/concepts - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/engineering-for-scale - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/going-to-prod - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/google-colab - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/hugging-face - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/langchain - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/python-clients + https://supabase.com/docs/guides/ai/rag-with-permissions weekly 0.5 @@ -358,6 +240,18 @@ 0.5 + + https://supabase.com/docs/guides/auth/native-mobile-deep-linking + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/native-mobile-login + weekly + 0.5 + + https://supabase.com/docs/guides/auth/phone-login weekly @@ -383,9 +277,6 @@ -<<<<<<< HEAD - https://supabase.com/docs/guides/database/arrays -======= https://supabase.com/docs/guides/cli/customizing-email-templates weekly 0.5 @@ -411,14 +302,11 @@ https://supabase.com/docs/guides/cli/managing-environments ->>>>>>> @{-1} weekly 0.5 -<<<<<<< HEAD -======= https://supabase.com/docs/guides/cli/seeding-your-database weekly 0.5 @@ -430,122 +318,6 @@ 0.5 - - https://supabase.com/docs/guides/database/arrays - weekly - 0.5 - - - ->>>>>>> @{-1} - https://supabase.com/docs/guides/database/column-encryption - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/connecting-to-postgres - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/full-text-search - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/functions - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/inspect - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/json - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/managing-passwords - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/managing-timezones - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/overview - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/partitions - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/query-optimization - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/replication - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/sql-to-api - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/tables - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/testing - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/vault - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/webhooks -<<<<<<< HEAD - weekly - 0.5 - - https://supabase.com/docs/guides/api/api-keys weekly @@ -578,110 +350,6 @@ https://supabase.com/docs/guides/api/using-custom-schemas -======= ->>>>>>> @{-1} - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/auth - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/cicd-workflow - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/connect-to-postgres - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/cors - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/dart-edge - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/debugging - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/global-deployments - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/import-maps - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/kysely-postgres - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/local-development - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/quickstart - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/schedule-functions - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/secrets - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/storage-caching - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/troubleshooting - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/typescript-support - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/unit-test weekly 0.5 @@ -800,6 +468,12 @@ 0.5 + + https://supabase.com/docs/guides/platform/multi-factor-authentication + weekly + 0.5 + + https://supabase.com/docs/guides/platform/network-restrictions weekly @@ -921,31 +595,7 @@ - https://supabase.com/docs/guides/resources/examples - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/glossary - weekly - 0.5 - - - - https://supabase.com/docs/guides/storage/access-control - weekly - 0.5 - - - - https://supabase.com/docs/guides/storage/cdn - weekly - 0.5 - - - - https://supabase.com/docs/guides/storage/image-transformations + https://supabase.com/docs/guides/self-hosting/docker weekly 0.5 @@ -956,24 +606,6 @@ 0.5 - - https://supabase.com/docs/guides/storage/storage-sample - weekly - 0.5 - - - - https://supabase.com/docs/guides/storage/uploads - weekly - 0.5 - - - - https://supabase.com/docs/guides/self-hosting/docker - weekly - 0.5 - - https://supabase.com/docs/learn/auth-deep-dive/auth-deep-dive-jwts weekly @@ -1005,27 +637,240 @@ -<<<<<<< HEAD -======= - https://supabase.com/docs/guides/api/rest/auto-generated-docs + https://supabase.com/docs/guides/database/arrays weekly 0.5 - https://supabase.com/docs/guides/api/rest/client-libs + https://supabase.com/docs/guides/database/column-encryption weekly 0.5 - https://supabase.com/docs/guides/api/rest/generating-types + https://supabase.com/docs/guides/database/connecting-to-postgres + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/full-text-search + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/functions + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/inspect + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/json + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/managing-passwords + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/managing-timezones + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/overview + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/partitions + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/query-optimization + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/replication + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/sql-to-api + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/tables + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/testing + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/vault + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/webhooks + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/auth + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/cicd-workflow + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/connect-to-postgres + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/cors + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/dart-edge + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/debugging + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/global-deployments + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/import-maps + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/kysely-postgres + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/local-development + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/quickstart + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/schedule-functions + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/secrets + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/storage-caching + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/troubleshooting + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/typescript-support + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/unit-test + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/examples + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/glossary + weekly + 0.5 + + + + https://supabase.com/docs/guides/ai/integrations/llamaindex weekly 0.5 ->>>>>>> @{-1} https://supabase.com/docs/guides/ai/examples/building-chatgpt-plugins weekly 0.5 @@ -1062,57 +907,18 @@ -<<<<<<< HEAD https://supabase.com/docs/guides/ai/quickstarts/face-similarity -======= - https://supabase.com/docs/guides/ai/integrations/llamaindex ->>>>>>> @{-1} weekly 0.5 -<<<<<<< HEAD https://supabase.com/docs/guides/ai/quickstarts/generate-text-embeddings -======= - https://supabase.com/docs/guides/ai/quickstarts/face-similarity ->>>>>>> @{-1} weekly 0.5 -<<<<<<< HEAD - https://supabase.com/docs/guides/ai/quickstarts/hello-world -======= - https://supabase.com/docs/guides/ai/quickstarts/generate-text-embeddings ->>>>>>> @{-1} - weekly - 0.5 - - - -<<<<<<< HEAD - https://supabase.com/docs/guides/ai/quickstarts/text-deduplication - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/integrations/llamaindex - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/vector-indexes/hnsw-indexes - weekly - 0.5 - - - - https://supabase.com/docs/guides/ai/vector-indexes/ivf-indexes -======= https://supabase.com/docs/guides/ai/quickstarts/hello-world weekly 0.5 @@ -1120,7 +926,6 @@ https://supabase.com/docs/guides/ai/quickstarts/text-deduplication ->>>>>>> @{-1} weekly 0.5 @@ -1161,6 +966,32 @@ 0.5 + + https://supabase.com/docs/guides/auth/quickstarts/nextjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/quickstarts/react + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/server-side/email-based-auth-with-pkce-flow-for-ssr + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/server-side/oauth-with-pkce-flow-for-ssr + weekly + 0.5 + + https://supabase.com/docs/guides/auth/concepts/redirect-urls weekly @@ -1186,8 +1017,6 @@ -<<<<<<< HEAD -======= https://supabase.com/docs/guides/ai/vector-indexes/hnsw-indexes weekly 0.5 @@ -1199,33 +1028,6 @@ 0.5 - ->>>>>>> @{-1} - https://supabase.com/docs/guides/auth/quickstarts/nextjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/auth/quickstarts/react - weekly - 0.5 - - - - https://supabase.com/docs/guides/auth/server-side/email-based-auth-with-pkce-flow-for-ssr - weekly - 0.5 - - - - https://supabase.com/docs/guides/auth/server-side/oauth-with-pkce-flow-for-ssr - weekly - 0.5 - - https://supabase.com/docs/guides/auth/social-login/auth-apple weekly @@ -1340,12 +1142,516 @@ 0.5 + + https://supabase.com/docs/guides/getting-started/quickstarts/flutter + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/kotlin + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/nextjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/nuxtjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/reactjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/redwoodjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/refine + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/solidjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/sveltekit + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/quickstarts/vue + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-angular + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-expo-react-native + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-flutter + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-ionic-angular + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-ionic-react + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-ionic-vue + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-kotlin + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-nextjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-nuxt-3 + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-react + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-redwoodjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-refine + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-solidjs + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-svelte + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-sveltekit + weekly + 0.5 + + + + https://supabase.com/docs/guides/getting-started/tutorials/with-vue-3 + weekly + 0.5 + + + + https://supabase.com/docs/guides/api/rest/auto-generated-docs + weekly + 0.5 + + + + https://supabase.com/docs/guides/api/rest/client-libs + weekly + 0.5 + + + + https://supabase.com/docs/guides/api/rest/generating-types + weekly + 0.5 + + https://supabase.com/docs/guides/auth/sso/auth-sso-saml weekly 0.5 + + https://supabase.com/docs/guides/platform/sso/azure + weekly + 0.5 + + + + https://supabase.com/docs/guides/platform/sso/gsuite + weekly + 0.5 + + + + https://supabase.com/docs/guides/platform/sso/okta + weekly + 0.5 + + + + https://supabase.com/docs/guides/self-hosting/analytics/config + weekly + 0.5 + + + + https://supabase.com/docs/guides/realtime/guides/client-side-throttling + weekly + 0.5 + + + + https://supabase.com/docs/guides/self-hosting/realtime/config + weekly + 0.5 + + + + https://supabase.com/docs/guides/self-hosting/storage/config + weekly + 0.5 + + + + https://supabase.com/docs/guides/self-hosting/auth/config + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/cdn/fundamentals + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/cdn/metrics + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/cdn/smart-cdn + weekly + 0.5 + + + + https://supabase.com/docs/guides/platform/oauth-apps/build-a-supabase-integration + weekly + 0.5 + + + + https://supabase.com/docs/guides/platform/oauth-apps/oauth-scopes + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/buckets/creating-buckets + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/buckets/fundamentals + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/schema/design + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/schema/helper-functions + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/serving/downloads + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/serving/image-transformations + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/production/scaling + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/security/access-control + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/debugging/error-codes + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/debugging/logs + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/uploads/file-limits + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/uploads/resumable-uploads + weekly + 0.5 + + + + https://supabase.com/docs/guides/storage/uploads/standard-uploads + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/cascade-deletes + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/configuration + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/dropping-all-tables-in-schema + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/first-row-in-group + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/indexes + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/roles + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/row-level-security + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/triggers + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/postgres/which-version-of-postgres + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/cloudflare-turnstile + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/discord-bot + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/github-actions + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/og-image + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/rate-limiting + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/screenshots + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/send-emails + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/slack-bot-mention + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/stripe-webhooks + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/telegram-bot + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/examples/upstash-redis + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/amazon-rds + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-auth + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-storage + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/firestore-data + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/heroku + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/mssql + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/mysql + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/postgres + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/render + weekly + 0.5 + + https://supabase.com/docs/guides/database/extensions/http weekly @@ -1502,491 +1808,6 @@ 0.5 - -<<<<<<< HEAD - https://supabase.com/docs/guides/api/graphql/graphiql - weekly - 0.5 - - - - https://supabase.com/docs/guides/api/rest/auto-generated-docs - weekly - 0.5 - - - - https://supabase.com/docs/guides/api/rest/client-libs - weekly - 0.5 - - - - https://supabase.com/docs/guides/api/rest/generating-types - weekly - 0.5 - - - -======= ->>>>>>> @{-1} - https://supabase.com/docs/guides/database/postgres/cascade-deletes - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/configuration - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/dropping-all-tables-in-schema - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/first-row-in-group - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/indexes - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/roles - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/row-level-security - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/triggers - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/postgres/which-version-of-postgres - weekly - 0.5 - - - -<<<<<<< HEAD -======= - https://supabase.com/docs/guides/platform/oauth-apps/build-a-supabase-integration - weekly - 0.5 - - - ->>>>>>> @{-1} - https://supabase.com/docs/guides/functions/examples/cloudflare-turnstile - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/discord-bot - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/github-actions - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/og-image - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/rate-limiting - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/screenshots - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/send-emails - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/stripe-webhooks - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/telegram-bot - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/upstash-redis - weekly - 0.5 - - - -<<<<<<< HEAD - https://supabase.com/docs/guides/getting-started/quickstarts/flutter - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/kotlin - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/nextjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/nuxtjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/reactjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/redwoodjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/refine - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/solidjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/sveltekit - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/vue - weekly - 0.5 - - - - https://supabase.com/docs/guides/platform/oauth-apps/build-a-supabase-integration - weekly - 0.5 - - - -======= ->>>>>>> @{-1} - https://supabase.com/docs/guides/getting-started/tutorials/with-angular - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-expo - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-flutter - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-ionic-angular - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-ionic-react - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-ionic-vue - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-kotlin - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-nextjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-nuxt-3 - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-react - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-redwoodjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-refine - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-solidjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-svelte - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-sveltekit - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/tutorials/with-vue-3 -<<<<<<< HEAD -======= - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/flutter - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/kotlin - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/nextjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/nuxtjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/reactjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/redwoodjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/refine - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/solidjs - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/sveltekit - weekly - 0.5 - - - - https://supabase.com/docs/guides/getting-started/quickstarts/vue ->>>>>>> @{-1} - weekly - 0.5 - - - - https://supabase.com/docs/guides/platform/sso/azure - weekly - 0.5 - - - - https://supabase.com/docs/guides/platform/sso/gsuite - weekly - 0.5 - - - - https://supabase.com/docs/guides/platform/sso/okta - weekly - 0.5 - - - - https://supabase.com/docs/guides/realtime/guides/client-side-throttling - weekly - 0.5 - - - -<<<<<<< HEAD -======= - https://supabase.com/docs/guides/self-hosting/analytics/config - weekly - 0.5 - - - ->>>>>>> @{-1} - https://supabase.com/docs/guides/resources/migrating-to-supabase/amazon-rds - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-auth - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-storage - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/firestore-data - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/heroku - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/render - weekly - 0.5 - - - -<<<<<<< HEAD - https://supabase.com/docs/guides/self-hosting/analytics/config -======= - https://supabase.com/docs/guides/self-hosting/realtime/config - weekly - 0.5 - - - - https://supabase.com/docs/guides/self-hosting/storage/config ->>>>>>> @{-1} - weekly - 0.5 - - - - https://supabase.com/docs/guides/self-hosting/auth/config - weekly - 0.5 - - - -<<<<<<< HEAD - https://supabase.com/docs/guides/self-hosting/realtime/config - weekly - 0.5 - - - - https://supabase.com/docs/guides/self-hosting/storage/config -======= - https://supabase.com/docs/guides/database/extensions/wrappers/overview ->>>>>>> @{-1} - weekly - 0.5 - - https://supabase.com/docs/guides/database/extensions/wrappers/overview weekly @@ -2469,6 +2290,12 @@ 0.5 + + https://supabase.com/docs/reference/javascript/broadcastmessage + weekly + 0.5 + + https://supabase.com/docs/reference/javascript/getchannels weekly @@ -3183,6 +3010,150 @@ 0.5 + + https://supabase.com/docs/reference/python/update + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/upsert + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/delete + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/using-filters + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/eq + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/neq + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/gt + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/gte + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/lt + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/lte + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/like + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/ilike + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/is + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/in + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/contains + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/containedby + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/match + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/not + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/filter + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/using-modifiers + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/order + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/limit + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/single + weekly + 0.5 + + + + https://supabase.com/docs/reference/python/maybesingle + weekly + 0.5 + + https://supabase.com/docs/reference/python/functions-invoke weekly @@ -3261,12 +3232,6 @@ 0.5 - - https://supabase.com/docs/reference/python/subscribe - weekly - 0.5 - - https://supabase.com/docs/reference/csharp/initializing weekly @@ -4665,6 +4630,30 @@ 0.5 + + https://supabase.com/docs/reference/cli/supabase-snippets + weekly + 0.5 + + + + https://supabase.com/docs/reference/cli/supabase-snippets-list + weekly + 0.5 + + + + https://supabase.com/docs/reference/cli/supabase-snippets-download + weekly + 0.5 + + + + https://supabase.com/docs/reference/cli/supabase-services + weekly + 0.5 + + https://supabase.com/docs/reference/cli/supabase-secrets weekly @@ -4701,6 +4690,12 @@ 0.5 + + https://supabase.com/docs/reference/cli/supabase-projects-delete + weekly + 0.5 + + https://supabase.com/docs/reference/cli/supabase-projects-create weekly @@ -5025,6 +5020,24 @@ 0.5 + + https://supabase.com/docs/reference/cli/supabase-encryption + weekly + 0.5 + + + + https://supabase.com/docs/reference/cli/supabase-encryption-update-root-key + weekly + 0.5 + + + + https://supabase.com/docs/reference/cli/supabase-encryption-get-root-key + weekly + 0.5 + + https://supabase.com/docs/reference/cli/supabase-domains weekly diff --git a/apps/www/_blog/2021-07-27-storage-beta.mdx b/apps/www/_blog/2021-07-27-storage-beta.mdx index 817d32d4e72..f9449c456d0 100644 --- a/apps/www/_blog/2021-07-27-storage-beta.mdx +++ b/apps/www/_blog/2021-07-27-storage-beta.mdx @@ -38,7 +38,7 @@ You can make objects public in S3 via multiple mechanisms (e.g. tags, or prefixe Objects in public buckets can be accessed via a URL without any Authorization tokens or headers. This makes them perfect for hosting assets for your web or mobile application. -Public buckets still require [Auth Policies](/docs/guides/storage#policy-examples) to upload and delete objects, allowing you to securely manage their contents. +Public buckets still require [Auth Policies](/docs/guides/storage/security/access-control#policy-examples) to upload and delete objects, allowing you to securely manage their contents.