Description

Ensure any custom domain configured for the project, such as api.example.com, has completed DNS verification and SSL certificate issuance and has been activated. Domains should not be left in a pending or failed state, and unused custom domain setups should be removed.

Rationale

A custom domain that is not fully verified may not have a valid SSL certificate, causing errors or insecure connections for users. Pending setups with DNS records left in place can also create confusion or be taken over later. Completing verification and activation makes sure the domain serves traffic securely with a valid certificate.

Impact

  • The custom domain serves traffic with a valid SSL certificate

  • Avoids broken or insecure connections for users

  • Auth and OAuth settings may need updating after activation

Default Value

Custom domains are a paid add-on. After a domain is added, it stays pending until its DNS records are verified and it is activated.

Pre-Requisites

  • Project Owner or Admin role

  • Custom Domain add-on

  • Access to the domain's DNS settings

  • Supabase CLI for reverify and activate commands

Test Plan

  1. Sign in to the Supabase Dashboard at https://supabase.com/dashboard.

  2. Select your project.

  3. Open Project Settings and select General, then go to the Custom Domains section.

  4. Verify that the custom domain shows as active with a verified certificate.

  5. If it shows pending or failed, follow the implementation steps.

Implementation Steps

  1. In your DNS provider, confirm the CNAME record points to your project's supabase.co domain and that the TXT verification records are added exactly as shown.

  2. Run: supabase domains reverify --project-ref <project-ref>

  3. When verification succeeds, run: supabase domains activate --project-ref <project-ref>

  4. Check the Custom Domains section again and confirm the domain is active.

Backout Plan

  1. Run: supabase domains delete --project-ref <project-ref> to remove the custom domain.

  2. Remove the related CNAME and TXT records from your DNS provider.

Reference