Skip to content

Commit 97f75c0

Browse files
Michellehbnpcuencajulien-cburtenshaw
authored
Create spaces-custom-domain.md (#1746)
* Create spaces-custom-domain.md * Update spaces-custom-domain.md * Update spaces-custom-domain.md * Apply suggestions from code review Co-authored-by: Julien Chaumond <[email protected]> Co-authored-by: burtenshaw <[email protected]> --------- Co-authored-by: Pedro Cuenca <[email protected]> Co-authored-by: Julien Chaumond <[email protected]> Co-authored-by: burtenshaw <[email protected]>
1 parent 297387b commit 97f75c0

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/hub/spaces-custom-domain.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Spaces Custom Domain
2+
3+
4+
<Tip warning={true}>
5+
Spaces Custom Domain feature is part of PRO and Team or Enterprise subscriptions.
6+
</Tip>
7+
8+
## Getting started with a Custom Domain
9+
10+
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.
11+
12+
<div class="flex justify-center">
13+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/custom-domain-feature_light.png"/>
14+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/custom-domain-feature_dark.png"/>
15+
</div>
16+
17+
## Using a Custom Domain
18+
19+
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:
20+
21+
<div class="flex justify-center">
22+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/custom-domain-dns_light.png"/>
23+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/custom-domain-dns_dark.png"/>
24+
</div>
25+
26+
The request will move to 'pending' status after submission as seen below.
27+
28+
<div class="flex justify-center">
29+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/custom-domain-pending_light.png"/>
30+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/custom-domain-pending_dark.png"/>
31+
</div>
32+
33+
Please make sure to point the domain to `hf.space`. Once set up, you'll see a 'ready' status to know the custom domain is active for your Space 🔥
34+
35+
## Removing a Custom Domain
36+
37+
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

Comments
 (0)