Skip to content

Commit dc8c965

Browse files
authored
1 parent 57e1ad1 commit dc8c965

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

docs/user/guides/custom-domains.rst

+30-3
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,18 @@ To setup your :doc:`custom domain </custom-domains>`, follow these steps:
2020
#. At the top of the next page you'll find the value of the DNS record that you need to point your domain to.
2121
For |org_brand| this is ``readthedocs.io``, and for :doc:`/commercial/index`
2222
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.
2624

2725
.. note::
2826

2927
For a subdomain like ``docs.example.com`` add a CNAME record,
3028
and for a root domain like ``example.com`` use an ANAME or ALIAS record.
3129

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+
3235
We provide a validated SSL certificate for the domain,
3336
managed by `Cloudflare <https://www.cloudflare.com/>`_.
3437
The SSL certificate issuance should happen within a few minutes,
@@ -58,13 +61,19 @@ To remove a custom domain:
5861
#. Click on :guilabel:`Domains`.
5962
#. Click the :guilabel:`Remove` button next to the domain.
6063
#. Click :guilabel:`Confirm` on the confirmation page.
64+
#. Remove the DNS record for the domain from your DNS provider.
6165

6266
.. warning::
6367

6468
Once a domain is removed,
6569
your previous documentation domain is no longer served by Read the Docs,
6670
and any request for it will return a 404 Not Found!
6771

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+
6877
Strict Transport Security (HSTS) and other custom headers
6978
---------------------------------------------------------
7079

@@ -97,6 +106,24 @@ This is `a way to boost the SEO of your website <https://moz.com/blog/subdomains
97106
Troubleshooting
98107
---------------
99108

109+
"Error 1014: CNAME Cross-User Banned" when using Cloudflare
110+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111+
112+
Read the Docs uses Cloudflare to manage SSL certificates for custom domains,
113+
CDN caching, and other features that require the domain to be completely managed by our Cloudflare account.
114+
115+
If you see an "Error 1014: CNAME Cross-User Banned" message,
116+
it means that the domain is already managed by another Cloudflare account.
117+
To fix this, you need to:
118+
119+
#. Log in your Cloudflare account (https://www.cloudflare.com/).
120+
#. Select your domain.
121+
#. Click on "DNS".
122+
#. Find your CNAME record and click on "Edit".
123+
#. Uncheck the "Proxy status" (orange cloud) option.
124+
#. Leave everything else unchanged.
125+
#. Click on save.
126+
100127
SSL certificate issue delays
101128
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102129

0 commit comments

Comments
 (0)