|
| 1 | +# Spaces Custom Domain |
| 2 | + |
| 3 | +<Tip warning={true}> |
| 4 | +This feature is still in Beta stage. |
| 5 | +</Tip> |
| 6 | + |
| 7 | +<Tip warning={true}> |
| 8 | +Spaces Custom Domain feature is part of PRO and Enterprise Hub subscriptions. |
| 9 | +</Tip> |
| 10 | + |
| 11 | +## Getting started with a Custom Domain |
| 12 | + |
| 13 | +Spaces Custom Domain is a feature that allows you to host your space in a custom domain of your choosing: yourdomain.example.com. The custom domain must be a valid DNS name. |
| 14 | + |
| 15 | +<div class="flex justify-center" style="max-width: 550px"> |
| 16 | +<img class="block dark:hidden m-0!" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/custom-domain-feature_light.png" alt="screenshot of custom domain feature"/> |
| 17 | +<img class="hidden dark:block m-0!" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/custom-domain-feature_dark.png" alt="screenshot of custom domain feature"/> |
| 18 | +</div> |
| 19 | + |
| 20 | +## Using a Custom Domain |
| 21 | + |
| 22 | +You can submit a custom domain to host your space in the settings of your Space, under "Custom Domain". You'll need to add the CNAME Record Type: |
| 23 | + |
| 24 | +<div class="flex justify-center" style="max-width: 550px"> |
| 25 | +<img class="block dark:hidden m-0!" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/custom-domain-dns_light.png" alt="screenshot of using custom domain"/> |
| 26 | +<img class="hidden dark:block m-0!" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/custom-domain-dns_dark.png" alt="screenshot of using custom domain"/> |
| 27 | +</div> |
| 28 | + |
| 29 | +The request will move to 'PENDING' status after submission as seen below. |
| 30 | + |
| 31 | +<div class="flex justify-center" style="max-width: 550px"> |
| 32 | +<img class="block dark:hidden m-0!" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/custom-domain-pending_light.png" alt="screenshot of custom domain pending”/> |
| 33 | +<img class="hidden dark:block m-0!" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/custom-domain-pending_dark.png" alt="screenshot of custom domain pending"/> |
| 34 | +</div> |
| 35 | + |
| 36 | +Please make sure to point the domain to Hugging Face Spaces. Once set up, you'll see a 'READY' status to know the custom domain is active for your Space 🔥 |
| 37 | + |
| 38 | +## Removing a Custom Domain |
| 39 | + |
| 40 | +Simply remove a custom domain by using the delete button to the right of “Custom Domain” in the settings of your Space. You can delete while the custom domain is pending or in ready state. |
0 commit comments