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

Jump to bottom

Custom domain clarifications #4514

Merged
merged 2 commits into from
Aug 13, 2018
Merged

Custom domain clarifications #4514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1472975
Custom domain clarification
davidfischer Aug 13, 2018
1b07500
Add a link to the docs from the domain list screen
davidfischer Aug 13, 2018
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
9 changes: 7 additions & 2 deletions docs/alternate_domains.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ By default, when you setup a custom domain to host documentation at Read the Doc
we will attempt to provision a domain validated SSL certificate for the domain.
This service is generously provided by Cloudflare.

If your domain has configred CAA records, please do not forget to include
After configuring your custom domain on Read the Docs,
you can see the status of the certificate on the domain edit screen
(**Project Admin > Domains > Edit Domain**).

If your domain has configured CAA records, please do not forget to include
Cloudflare CAA entries, see their `Certification Authority Authorization (CAA)
FAQ <https://support.cloudflare.com/hc/en-us/articles/115000310832-Certification-Authority-Authorization-CAA-FAQ>`_.

Expand All @@ -55,7 +59,8 @@ FAQ <https://support.cloudflare.com/hc/en-us/articles/115000310832-Certification
Some older setups configured a CNAME record pointing to ``readthedocs.org``
or another variation. While these continue to resolve,
they do not yet allow us to acquire SSL certificates for those domains.
Simply point the CNAME to ``readthedocs.io``.
Point the CNAME to ``readthedocs.io`` and re-request a certificate
by saving the domain (**Project Admin > Domains > Edit Domain**).

If you change the CNAME, the SSL certificate issuance can take about one hour.

Expand Down
3 changes: 3 additions & 0 deletions readthedocs/templates/projects/domain_list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
{% block project_edit_content_header %}{% trans "Domains" %}{% endblock %}

{% block project_edit_content %}
{# Remove anytime after 2018-10-01 #}
<p class="empty">{% blocktrans %}Recently we added HTTPS support for custom domains. Depending on your setup, you may need to take action for your domain to support HTTPS. <a href="https://docs.readthedocs.io/en/latest/alternate_domains.html#cname-ssl">See our docs</a> for details.{% endblocktrans %}</p>

<p class="help_text">
{% trans "This allows you to add domains to your project. This allows them to live in the same namespace in the URLConf for a subdomain or CNAME." %}
</p>
Expand Down