-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Use <slug>.readthedocs.io
for suggested custom domain endpoint
#4521
Comments
There is a ticket with solutions for users experiencing issues with Cloudflare #4395. |
This is a bit of a tricky situation since it's not really easy for us to tell which domains will have problems once we make this change. We don't really know which projects have their custom domains proxying through Cloudflare. Perhaps the right solution here is to make the switch and have a test script where we can uncover these issues quickly and then either put workarounds in place or contact the project authors proactively. |
@davidfischer I forgot where we landed on this. Does the above point still stand? Should we script up something that resolves the custom project domains to detect cloudflare proxying first? |
I think we should script something and try to detect it. There's probably not too many projects that it will affect. I'd estimate ~5-10 but it's worth figuring it out first. |
Roger. In terms of priorities, this is pretty low and we're a few versions out from making this change. Perhaps this is a v3 change in fact. |
@rtfd/core, how do we feel about making this a v3.0 release item EOY? |
I'm +1. |
There's actually more like 40. I ran a script over our ~3k domains which checked if the custom domain pointed to a CNAME matching Interestingly, I also found ~7 projects that were pointed to |
I do wonder if we should CNAME to |
From a Cloudflare perspective, it only has to resolve to a domain we control. We could probably do something like |
Makes sense, but curious what the reasons are. Just to keep it consistent with the domain we're hosting docs on? |
It is conceivable that in the future .org and .io are not even served by the same servers. |
I added the relevant DNS entry for |
I should also mention I verified it by adding a custom domain that resolves to |
Now that I think about this a little further, there is at least one drawback to using |
One of my goal is being able to seperate the operational aspects of DNS around So for example:
This would be really convoluted if we wanted to repoint |
We should consider this again now that we're fully on CloudFlare for DNS. Do we want to point users to a slug-specific domain again? I see benefits of each approach:
|
@ericholscher @stsewd is this issue still relevant after all the migration you have done regarding custom domains? |
On .com we are using a hash for the CNAME to protect users from subdomain hijacking. |
<slug>.readthedocs.io
for suggested custom domain endpoint
Our custom domain directions tell people to CNAME to readthedocs.io. One idea that might be nice is to have them CNAME to
<slug>.readthedocs.io
. This would let us configure DNS for a single domain rather than making large changes.In order for this to work, we need to tweak our Cloudflare settings to have the "orange cloud" for
*.readthedocs.io
. Projects that already proxy through cloudflare and have their DNS set to<slug>.readthedocs.io
will have issues that can be solved with the directions here. I expect there's no more than a handful of these.The text was updated successfully, but these errors were encountered: