You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Farmstead Stand (https://farmsteadstand.com) is an online store and
point-of-sale platform for small farms. It also runs the Homestead Stand
brand. These templates let a farm connect its own domain without editing
DNS by hand:
storefront: points a subdomain (e.g. shop.theirfarm.com) at ssl.farmsteadstand.com, our Cloudflare for SaaS fallback origin.
storefront-homestead: the same for Homestead Stand stores
(ssl.homesteadstand.com).
email: the records our email provider (Resend, sending through Amazon
SES) needs to send from the farm's domain: a DKIM key, the bounce MX,
and SPF for the return-path subdomain send.
All three are used with the synchronous flow and signed links.
Type of change
Please mark options that are relevant.
New template
Bug fix (non-breaking change which fixes an issue in the template)
New feature (non-breaking change which adds functionality to the template)
Breaking change (fix or feature that would cause existing template behavior to be not backward compatible)
Template file name follows the pattern <providerId>.<serviceId>.json
resource URL provided with logoUrl is actually served by a webserver
Checklist of common problems
Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
See Template Quality Guidelines for details and rationale on each rule.
syncPubKeyDomain is set — this is mandatory; omitting it requires explicit justification in the PR description or the PR will be rejected
warnPhishing is not set alongside syncPubKeyDomain — the two must not appear together
syncRedirectDomain is set whenever the template uses redirect_uri in the synchronous flow
no TXT record contains SPF content ("v=spf1 ...") — use the SPFM record type instead
txtConflictMatchingMode is set on every TXT record that must be unique per label or content prefix (e.g. DMARC)
no variable is used as a bare full record value (e.g. @ TXT "%foo%") unless necessary — prefer @ TXT "service-foo=%foo%"; if bare, justify in the PR description
no bare variable is used as the full host label — the non-variable parts are fixed to limit misuse (e.g. %dkimkey%._domainkey, not %dkimhost%); if bare, justify in the PR description
no variable is used in the host field to create a subdomain — use the host parameter or multiInstance instead
%host% does not appear explicitly in any host attribute
essential is set to OnApply on records the end user may need to modify or remove without breaking the template (e.g. DMARC)
Notes:
The storefront templates have no variables. Each brand's CNAME target
is fixed in its own template.
The email template has one variable, dkimkey, embedded after a fixed p= prefix in the resend._domainkey TXT record. The key is issued per
domain by our email provider, so it can't be fixed in the template. The
DKIM selector (resend) and the MX and SPF values are fixed.
No record in these templates is one a user would need to remove on its
own, so essential is left at its default.
OK Type of change: 1/4 checkboxes ticked
OK How Has This Been Tested?: all 3 checkboxes ticked
OK Checklist of common problems: 10/10 checkboxes ticked
OK Online Editor test results: 4 link(s) found
OK Template coverage: all 3 template(s) covered
Labels to remove: Checklist of common problems not complete, Forged editor links, PR description incomplete, Test links missing
PR description check PASSED
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
automerge-possibleLabel indicating, that restrictive linter checks all pass. For now it's PoC.hostRequiredhostRequired is set
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Farmstead Stand (https://farmsteadstand.com) is an online store and
point-of-sale platform for small farms. It also runs the Homestead Stand
brand. These templates let a farm connect its own domain without editing
DNS by hand:
storefront: points a subdomain (e.g.shop.theirfarm.com) atssl.farmsteadstand.com, our Cloudflare for SaaS fallback origin.storefront-homestead: the same for Homestead Stand stores(
ssl.homesteadstand.com).email: the records our email provider (Resend, sending through AmazonSES) needs to send from the farm's domain: a DKIM key, the bounce MX,
and SPF for the return-path subdomain
send.All three are used with the synchronous flow and signed links.
Type of change
Please mark options that are relevant.
How Has This Been Tested?
Please mark the following checks done
<providerId>.<serviceId>.jsonlogoUrlis actually served by a webserverChecklist of common problems
Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
See Template Quality Guidelines for details and rationale on each rule.
syncPubKeyDomainis set — this is mandatory; omitting it requires explicit justification in the PR description or the PR will be rejectedwarnPhishingis not set alongsidesyncPubKeyDomain— the two must not appear togethersyncRedirectDomainis set whenever the template usesredirect_uriin the synchronous flow"v=spf1 ...") — use theSPFMrecord type insteadtxtConflictMatchingModeis set on every TXT record that must be unique per label or content prefix (e.g. DMARC)@ TXT "%foo%") unless necessary — prefer@ TXT "service-foo=%foo%"; if bare, justify in the PR descriptionhostlabel — the non-variable parts are fixed to limit misuse (e.g.%dkimkey%._domainkey, not%dkimhost%); if bare, justify in the PR descriptionhostfield to create a subdomain — use thehostparameter ormultiInstanceinstead%host%does not appear explicitly in anyhostattributeessentialis set toOnApplyon records the end user may need to modify or remove without breaking the template (e.g. DMARC)Notes:
is fixed in its own template.
dkimkey, embedded after a fixedp=prefix in theresend._domainkeyTXT record. The key is issued perdomain by our email provider, so it can't be fixed in the template. The
DKIM selector (
resend) and the MX and SPF values are fixed.own, so
essentialis left at its default.Online Editor test results
shop.theirfarm.com.ssl.farmsteadstand.comshop.theirfarm.com.ssl.homesteadstand.comresend._domainkey.theirfarm.com."p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDsc4Lh8xilsngyKEgN2S84"send.theirfarm.com.10 feedback-smtp.us-east-1.amazonses.comsend.theirfarm.com."v=spf1 include:amazonses.com ~all"resend._domainkey.mail.theirfarm.com."p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDsc4Lh8xilsngyKEgN2S84"send.mail.theirfarm.com.10 feedback-smtp.us-east-1.amazonses.comsend.mail.theirfarm.com."v=spf1 include:amazonses.com ~all""Check template" reported no problems for any of the three.
Editor test link(s):