Skip to content

Docs: add warning about removing CNAME record from DNS after removing a domain #11242

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
Closed
stsewd opened this issue Mar 25, 2024 · 1 comment · Fixed by readthedocs/ext-theme#515
Closed

Docs: add warning about removing CNAME record from DNS after removing a domain #11242

stsewd opened this issue Mar 25, 2024 · 1 comment · Fixed by readthedocs/ext-theme#515
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@stsewd
Copy link
Member

stsewd commented Mar 25, 2024

What's the problem this feature will solve?

To completely detach a custom domain from our platform, in addition to remove it, a user also needs to remove the CNAME from their DNS. Otherwise, any user may be able to link that domain to another project (subdomain hijacking).

Describe the solution you'd like

The proper solution is to use a unique hashed domain as the CNAME (#4521, https://github.com/readthedocs/readthedocs-ext/issues/549). But we should at least mention it in our docs until we implement that.

Mention this at
https://docs.readthedocs.io/en/stable/guides/custom-domains.html#removing-a-custom-domain

Additional context

Add any other context, links, etc. relevant to the feature request.
@stsewd stsewd mentioned this issue Mar 25, 2024
Closed
@humitos humitos added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels Mar 26, 2024
@humitos humitos changed the title Custom domain: add warning in docs about removing CNAME record from DNS after removing a domain Docs: add warning about removing CNAME record from DNS after removing a domain Mar 26, 2024
@stsewd
Copy link
Member Author

stsewd commented Aug 26, 2024

We should also mention this when removing a domain or project.

@stsewd stsewd mentioned this issue Oct 31, 2024
Merged
stsewd added a commit to readthedocs/ext-theme that referenced this issue Oct 31, 2024
@stsewd
Domain: show warning in a modal when deleting domain
380af8f 
- Closes #429
- Closes readthedocs/readthedocs.org#11242
@stsewd stsewd mentioned this issue Oct 31, 2024
Merged
stsewd added a commit that referenced this issue Nov 20, 2024
@stsewd
Docs: update custom domains docs (#11734)
dc8c965 
Closes #11371
ref #11242


https://docs--11734.org.readthedocs.build/en/11734/guides/custom-domains.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Domain: show warning in a modal when deleting domain readthedocs/ext-theme
2 participants
@humitos @stsewd