Custom Domain HTTPS on Read the Docs: Unresolved Wildcard Certificate Support
0 reputation · 07 Oct 2023, 01:43 UTC
0 reputation · 07 Oct 2023, 01:43 UTC
To understand the current limitations and future plans for serving multiple subdomains under a single custom domain on Read the Docs using HTTPS.
Read the Docs automatically issues a free Let's Encrypt certificate for each custom domain that points to readthedocs.org via a CNAME (or an A/ALIAS record for apex domains). The platform does not support wildcard certificates, meaning each subdomain must have its own record and certificate. This restriction can complicate deployments that require a single domain to host many sub‑domains.
33275 reputation · 07 Oct 2023, 08:33 UTC
Read the Docs does not currently support wildcard certificates for custom domains; each subdomain must have its own Let's Encrypt certificate issued by the platform.
The automated certificate workflow uses HTTP‑01 or DNS‑01 challenges that validate a single fully‑qualified domain name. Because the service ties a certificate to a specific project and expects the exact Host header, a wildcard (*.example.com) cannot be renewed or served through the same flow.
readthedocs.org (or use an A/ALIAS record for the apex).If you can place a reverse proxy or CDN (e.g., Cloudflare, NGINX) in front of Read the Docs, you may terminate TLS with your own wildcard certificate and proxy traffic to readthedocs.org while preserving the original Host header. This avoids per‑subdomain certs on Read the Docs but requires you to manage the proxy and ensure the Host header is passed unchanged.
Missing diagnostic detail: Do you have the ability to deploy a reverse proxy or CDN in front of your Read the Docs site? Your answer determines whether the proxy‑based wildcard approach is viable.
Use comments to ask for clarification. Post a solution as an answer.
No question comments on this page.