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.

Sign up for GitHub

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
Merged

Docs on supporting root domains #6923

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/custom_domains.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,17 @@ You can also host your documentation from your own domain.

.. note::

We don't currently support pointing subdomains or naked domains to a project using ``A`` records.
It's best to point a subdomain, ``docs.example.com`` for example, using a CNAME record.
We don't currently support pointing subdomains or root domains to a project using A records.
DNS A records require a static IP address and our IPs may change without notice.

.. 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

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

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.

#. Go the :guilabel:`Admin` tab of your project
#. Click on :guilabel:`Domains`
#. Enter your domain and click on :guilabel:`Add`
Expand Down