Skip to content

Use MAPTILER_KEY placeholder in example config; document per-site key setup #731

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.

Sign up for GitHub

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

Open
jamiefolsom wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Use MAPTILER_KEY placeholder in example config; document per-site key setup #731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ Copy the `.env.example` file to `.env` and enter required variables. For a local

Add a `/public/config.dev.json` file, which will be ignored by Git, to copy local config settings when starting the application. Use the `config.json` table below to configure your project.

#### MapTiler API key

Map layers reference a MapTiler style URL (`layers[].url`) that embeds an API key. `config.json` is served publicly, so treat the key as visible to every visitor:

1. Generate a **new key for each site** in [MapTiler Cloud](https://cloud.maptiler.com/account/keys/) — don't reuse a key across sites.
2. Restrict the key to the site's domains under **Allowed HTTP origins** (include `localhost` for local development). An unrestricted key can be copied from the public config and used by anyone, consuming your quota.
3. Replace the `MAPTILER_KEY` placeholder in your config with the new key.

To start, run:
```
npm install && netlify dev
Expand Down
2 changes: 1 addition & 1 deletion public/config.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"layers": [{
"name": "Maptiler DataViz Style",
"layer_type": "vector",
"url": "https://api.maptiler.com/maps/dataviz/style.json?key=WLMbLZP1AwK3zUFTeheB"
"url": "https://api.maptiler.com/maps/dataviz/style.json?key=MAPTILER_KEY"
}],
"search": [{
"name": "places",
Expand Down