Add WISP - Web Gateway - #1664
Open
mason-rogers wants to merge 1 commit into
Open
Conversation
New template for the Wisp game-server panel platform: one CNAME pointing a customer hostname at the panel's web gateway. pointsTo uses a bare %target% variable because Wisp is multi-tenant/white-label (gateway hostname differs per hosting company); apply requests are signed via syncPubKeyDomain dc.wisp.gg. hostRequired=true (apex CNAME impossible).
|
✅ JSON Filename Check Passed |
|
✅ JSON Schema Validation Passed |
Linter OK
|
| Level | Code | Note |
|---|
PR Description Check PassedAll required sections are filled in correctly. Details |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
New template for Wisp, a multi-tenant game-server panel platform. Customers point a hostname on their own domain at the web gateway operated by their hosting company's panel (reverse proxy with automatic on-demand HTTPS). The template creates a single CNAME.
Two deliberate choices worth calling out:
%target%inpointsTo: Wisp is white-label and multi-tenant — every hosting company's panel has its own gateway hostname (e.g.gateway.physgun.com), and node-local gateways have per-node hostnames, so the target cannot be fixed or suffixed in the template. Misuse is mitigated by mandatory request signing:syncPubKeyDomainis set and our panels always sign apply URLs.hostRequired: true: the gateway only serves hostnames below the zone apex (an apex CNAME would be invalid), so apex application is excluded at the protocol level.Type of change
How Has This Been Tested?
<providerId>.<serviceId>.jsonlogoUrlis actually served by a webserverdc-template-linter -loglevel info -tolerate warn wisp.gg.webgateway.jsonpasses with no findings.Checklist of common problems
syncPubKeyDomainis set —dc.wisp.ggwarnPhishingis not set alongsidesyncPubKeyDomainsyncRedirectDomainis set whenever the template usesredirect_uriin the synchronous flow — not used; the panel polls DNS instead of round-trippingtxtConflictMatchingModeis set on every TXT record that must be unique — no TXT recordspointsTo: %target%is bare by necessity; justification in the description abovehostlabel — host is@hostfield to create a subdomain%host%does not appear explicitly in anyhostattributeessentialis set appropriately —Alwayson the single CNAME; the record is the service, removing it disables itOnline Editor test results
Editor test link(s):
Test wisp.gg/webgateway viction.dev/connect