You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/guides/custom-domains.rst
+30-3
Original file line number
Diff line number
Diff line change
@@ -20,15 +20,18 @@ To setup your :doc:`custom domain </custom-domains>`, follow these steps:
20
20
#. At the top of the next page you'll find the value of the DNS record that you need to point your domain to.
21
21
For |org_brand| this is ``readthedocs.io``, and for :doc:`/commercial/index`
22
22
the record is in the form of ``<hash>.domains.readthedocs.com``.
23
-
24
-
25
-
**Once you have completed these steps and your new DNS entry has propagated (usually takes a few minutes), you need to build your project's published branches again so the Canonical URL is correct.**
23
+
If you are using Cloudflare, make sure to disable the proxy status (orange cloud) for the CNAME record.
26
24
27
25
.. note::
28
26
29
27
For a subdomain like ``docs.example.com`` add a CNAME record,
30
28
and for a root domain like ``example.com`` use an ANAME or ALIAS record.
31
29
30
+
.. warning::
31
+
32
+
If you delete a domain, make sure to also remove the DNS records for that domain.
33
+
Otherwise, another user may add the same domain to their project and serve that content from your domain (domain hijacking).
34
+
32
35
We provide a validated SSL certificate for the domain,
33
36
managed by `Cloudflare <https://www.cloudflare.com/>`_.
34
37
The SSL certificate issuance should happen within a few minutes,
@@ -58,13 +61,19 @@ To remove a custom domain:
58
61
#. Click on :guilabel:`Domains`.
59
62
#. Click the :guilabel:`Remove` button next to the domain.
60
63
#. Click :guilabel:`Confirm` on the confirmation page.
64
+
#. Remove the DNS record for the domain from your DNS provider.
61
65
62
66
.. warning::
63
67
64
68
Once a domain is removed,
65
69
your previous documentation domain is no longer served by Read the Docs,
66
70
and any request for it will return a 404 Not Found!
67
71
72
+
.. warning::
73
+
74
+
If you delete a domain, make sure to also remove the DNS records for that domain.
75
+
Otherwise, another user may add the same domain to their project and serve that content from your domain (domain hijacking).
76
+
68
77
Strict Transport Security (HSTS) and other custom headers
0 commit comments