-
Notifications
You must be signed in to change notification settings - Fork 74
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
Update custom domain docs to mention limitations around additional DNS records. #1113
Conversation
…S records. Signed-off-by: Luca <luca@rainsound.ai>
The CI failure is unrelated to this PR - #1114 refers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a comment with some inline changes (and optionally a suggestion about when the warning should be displayed, but feel free to take or leave it). Thanks again for the contribution, @photon-garden!
@@ -29,6 +29,8 @@ Currently, you can apply a maximum of one custom domain to your Spin application | |||
|
|||
Note that this propagation is generally performed in a reasonable time frame (minutes/hours). However, in some cases, propagation can take up to 72 hours. You can check the DNS record types for your domain name using the [Google Public DNS](https://dns.google/) service. | |||
|
|||
Be aware that updating your domain's nameserver records will cause any additional records you've set through you registrar to no longer take effect. This includes, for example, TXT or MX records for services like Google Workspace. You can work around this by connecting your Fermyon Cloud app to a subdomain. But if you need to use the apex domain (example.com rather than app.example.com) and you also need to set additional DNS records, you should choose a different hosting service for the time being. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making this edit! I made a few wording adjustments with this inline suggestion. One other consideration to take or leave: would it be possible to move this suggestion towards to the top of the article under a ## Limitations
header so users are aware a bit earlier in the tutorial in case it is a blocker for them?
Be aware that updating your domain's nameserver records will cause any additional records you've set through you registrar to no longer take effect. This includes, for example, TXT or MX records for services like Google Workspace. You can work around this by connecting your Fermyon Cloud app to a subdomain. But if you need to use the apex domain (example.com rather than app.example.com) and you also need to set additional DNS records, you should choose a different hosting service for the time being. | |
>> Additional records for custom domains are not supported on Fermyon Cloud at this time. This means any additional records (such as TXT or MX) you've set through your registrar no longer take effect once you've delegated your domain. If you need to assign your Spin application to an apex domain (`example.com` rather than `app.example.com`) _and_ you also need to set additional DNS records associated with that domain, please share this [feedback here](https://github.com/fermyon/feedback/issues/47). In the meantime, please consider delegating a subdomain or using a Fermyon custom subdomain for your Spin application instead. |
Thanks so much for this PR @photon-garden |
Thanks again @photon-garden for flagging this. |
Content must go through a pre-merge checklist.
Pre-Merge Content Checklist
This documentation has been checked to ensure that:
title
,template
, anddate
are all settemplates/*.hbs
files) that points to a document.md
that is set to publish in the future? If so please only publish the.md
and.hbs
changes in real-time (otherwise there will be a menu item pointing to a.md
file that does not exist)cat -ve <filename> | grep '^M' | wc -l
and expect 0 as a result)bart check
PREVIEW_MODE=1
and runnpm run styles
to update styling)npm run test
and resolved all errors