Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs on supporting root domains #6923

Merged
merged 1 commit into from Apr 27, 2020

Conversation

davidfischer
Copy link
Contributor

@davidfischer davidfischer commented Apr 17, 2020

I tested this process end-to-end and was able to add an ALIAS record on namecheap's DNS, Cloudflare issued the SSL cert, and RTD served it without issue.

@davidfischer davidfischer requested a review from Apr 17, 2020

.. tabs::

.. tab:: Read the Docs Community

In order to setup your custom domain, follow these steps:

#. Add a CNAME record in your DNS that points the domain to ``readthedocs.io``
#. For a subdomain like ``docs.example.com``, add a CNAME record in your DNS that points the domain to ``readthedocs.io``.
For a root domain like ``example.com`` use an ANAME or ALIAS record pointing to ``readthedocs.io``.
Copy link
Member

@humitos humitos Apr 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this also valid for commercial?

Copy link
Contributor Author

@davidfischer davidfischer Apr 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought I responded to this. I did not test this fully on .com. I don't see any reason why it wouldn't work but I think we should end-to-end test it before blessing it for commercial. Currently, it is just in the .org tab.

Copy link
Member

@ericholscher ericholscher left a comment

This looks 👍.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Apr 27, 2020

Merging this for deploy this week 👍

@ericholscher ericholscher merged commit 93bb8de into master Apr 27, 2020
2 checks passed
@ericholscher ericholscher deleted the davidfischer/root-custom-domain-support branch Apr 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants