docs: custom domains (#34914)

Add a note about custom domain compatibility for Edge Functions and Storage in response to customer inquiry about this.

Also snuck in a removal of the inline video since we're moving towards taking these out of all the docs pages.
This commit is contained in:
Charis authored and GitHub committed 2025-04-10 14:40:56 -04:00
1 parent f05a714eef
commit 725cd11cc7
1 file changed
+3 -10
@@ -2,20 +2,11 @@
id: 'custom-domains'
title: 'Custom Domains'
description: 'Use a custom domain instead of the default Supabase domain for your project.'
video: 'https://www.youtube.com/v/6rcGnW_Mh-0'
tocVideo: '6rcGnW_Mh-0'
---
Custom domains allow you to present a branded experience to your users. These are available as an [add-on for projects on a paid plan](/dashboard/project/_/settings/addons?panel=customDomain).
<div className="video-container">
<iframe
src="https://www.youtube-nocookie.com/embed/6rcGnW_Mh-0"
frameBorder="1"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>
</div>
There are two types of domains supported by Supabase:
1. Custom domains, where you use a domain such as `api.example.com` instead of the project's default domain.
@@ -136,6 +127,8 @@ import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://api.example.com', 'public-anon-key')
```
Similarly, your Edge Functions will now be available at `https://api.example.com/functions/v1/your_function_name`, and your Storage objects at `https://api.example.com/storage/v1/object/public/your_file_path.ext`.
### Remove a custom domain
Removing a custom domain may cause some issues when using Supabase Auth with OAuth or SAML. You may have to reverse the changes made in the _[Prepare to activate your domain](#prepare-to-activate-your-domain)_ step above.