feat(maps): support a CARTO basemaps API key - #80
Merged
Conversation
Keeps keyless tiles when CARTO_API_KEY is unset, and appends the key to tile requests when set.
streambinder
force-pushed
the
feat/carto-api-key
branch
from
September 5, 2026 08:18
f5ae015 to
8e7c73c
Compare
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
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.
CARTO started watermarking keyless raster tiles with
API KEY REQUIREDin late August 2026, so the Leaflet maps on the site now render with that overlay.This change reads a publishable CARTO basemaps API key from the
CARTO_API_KEYenvironment variable and exposes it to the map scripts through acarto-api-keymeta tag. The tile URL builder appends?key=when the tag is present and falls back to the exact previous keyless URL when it is not, so behavior is unchanged when the variable is unset. No CSP change is needed since*.basemaps.cartocdn.comis already allowed.Includes a focused unit test for the empty/set key handling and documents the new variable in
docs/installation.md.