Repository navigation
feat: guide new sites from creation to a working banner - #72
Merged
jamescottrill merged 10 commits intoOct 24, 2026
Merged
Conversation
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.
Why
A new site used to start empty. Nothing was scanned until someone found Trigger Scan, the install snippet had to be pieced together from the docs, there was no way to tell whether the banner was actually on the site, and nothing said what to do next or in what order.
As someone adding a site, I want to be taken from an empty site to a working banner, so that my site is compliant without having to know the steps beforehand or guess whether they worked.
What changes
First scan and scan progress
POST /sites/takes"start_scan": falseto skip it.POST /scan/stream, which reports progress after each page.SCANNER_TIMEOUT_SECONDSnow limits each page rather than the whole scan, so large sites that used to fail partway through now finish.Install guide
CDN_BASE_URLand the newPUBLIC_API_URL, falling back to the admin UI's own address, which is right for the default deployments.cdn.baseUrldefaults to empty instead ofhttps://cdn.example.com.Installation verification
POST /check-installand reports on each check, from the page loading to the banner appearing, with a fix for each failure.Setup checklist
Upgrade
POST /scanis unchanged for anything else that calls it.0014addssite_installations. Migration0015adds two setup columns tositesand marks already published sites as set up. Both run on startup and need no manual steps.CDN_BASE_URLwas previously unused. If it is set to an address that doesn't serveconsent-loader.js, the install snippet will be wrong. Snippets already on sites keep working.See the upgrade notes in
docs/deployment-guide.md, anddocs/scanning.md,docs/installing.mdanddocs/setting-up-a-site.mdfor the user guides and API.Testing
tsc -bis clean.helm lintpasses.CDN_BASE_URLis only rendered whencdn.baseUrlis set.