Enable Google Basemaps
For CARTO Self-Hosted
CARTO Self-hosted can be configured to use Google Basemaps in Builder, allowing you to choose between different Basemap styles provided by Google. All you need is a Google Maps API key and a few simple configuration steps.
Generate Google Maps API key
The CARTO Self-hosted deployment requires a Google Maps API key with the Google Maps JavaScript API enabled in order to use Google Basemaps from Builder. If you also want the Photorealistic 3D Tiles basemap, the Map Tiles API must be enabled on the same key. You can follow these steps to generate a new key:
Enable the Google Maps JavaScript API:
In the Google Cloud Console, navigate to the APIs & Services section and go to the Library tab
Click on the Enable APIs & Services button
Search for Google Maps JavaScript API and enable it. This API powers all 2D Google Basemaps (Roadmap, Satellite, Hybrid, Terrain, and the Google Maps versions of Positron, Voyager, and Dark Matter).
(Optional) Search for Map Tiles API and enable it only if you want the Photorealistic 3D Tiles basemap. Without it, the 3D Tiles option will fail to load in Builder; all other basemaps work without it.
Create Credentials:
After enabling the APIs, navigate to Credentials tab
Click on Create Credentials and pick API key. Your new API key should appear as soon as it's generated!
Copy Your API Key: This is the API Key that the CARTO Selfhosted instance will use to load the different Google Basemaps in Builder.
Already using Google Basemaps? If you previously configured a Google Maps API key that only has the Google Maps JavaScript API enabled, the Photorealistic 3D Tiles basemap will not work with it. You must additionally enable the Map Tiles API on the same key (or generate a new key with both APIs enabled and update your configuration).
Ensure the security of your API key by applying a restrictive usage policy. After setting up your API key, consider configuring key restrictions such as restricting it to the Google Maps JavaScript API (and the Map Tiles API, if you enabled it for 3D Tiles), and limiting its usage to your domain.
Configure your API Key in CARTO platform
In order to enable Google Maps basemaps inside CARTO Self Hosted, you need to own a Google Maps API key and add it to your configuration:
Add your Google Maps API key via the Admin Console:
Once you've applied the new API Key, Google Basemaps should be available in Builder!
Add one of the options below to your customizations file.
Option 1: Automatically create the secret
Automatically create a secret based on the plain text value specified in your customizations.yaml file.
Option 2: Manually create a secret:
Create a secret running the command below, after replacing the <REDACTED> values with your key values:
Add the following lines to your customizations.yaml, without replacing any value:
Last updated
Was this helpful?