How to obtain and install a Google Maps API Key

Owned by MS (Unlicensed)
Last updated: Feb 15, 2024
2 min read

Using Google Maps in Abiquo

Abiquo uses Google Maps for the map display, which requires the server to have Internet access. The map view is optional and statistics can be shown instead. In new installations, the map view is the default for Infrastructure view. In upgraded installations, to enable the map view, set the appropriate property in the client-config-custom.json file.

To plot the datacenter locations on the map, Abiquo uses the Google Maps Javascript API v3, and you cannot use a key for an older version.

Add the Google maps API key to the client-config-custom.json file.

Obtaining a Google Maps API Key

You should add a browser key for accessing the Google Maps Javascript API v3. 

If you were already using Google Maps with a previous version of the API, to obtain the key, follow the instructions at: https://cloud.google.com/maps-platform/user-guide/account-changes/

If you are a new user of Google Maps, follow the instructions at: https://developers.google.com/maps/gmp-get-started

You will need to obtain a browser key that can use the Google Maps Javascript API.

To add the API key you copied above to the Abiquo Server do these steps:

  1. Log in to the Abiquo Server as root

  2. Change to the UI directory

    cd /var/www/html/ui/config

  3. Back up the client-config-custom.json file, for example

    cp client-config-custom.json ~/client-config-custom.json.backup

  4. If necessary, edit client-config-custom.json to enable Google Maps   

    "client.google.maps.enabled": true, 

  5. Add the Google Maps key. For example:

  6. Reload Abiquo in your browser, which will log you out. 

  7. Confirm the installation by using "View Source" on the Abiquo login page. You should see the API key.

  8. When you log in to Abiquo, you should see the pins marking the locations of your datacenter.

If there are no valid credentials or datacenters with locations, the map will be centred on Barcelona, Spain.

Configure map defaults

To set the default coordinates and zoom for the datacenters map:

  1. Go to Configuration → Infrastructure

  2. At the bottom of the page, click the pencil Edit button

  3. Set the following coordinates

    1. Default latitude for datacenters map: decimal value with default set to Barcelona, Spain

    2. Default longitude for datacenters map: decimal value with default set to Barcelona, Spain

    3. Default zoom level for datacenters map 

Troubleshooting

  • Improve datacenter location details: If your datacenter is not correctly plotted, try adding more details of the location. For example, if your datacenter is located in Barcelona, Venezuela and you enter Barcelona, the map will show the location as Barcelona in Spain. In this case, you would enter "Barcelona, Venezuela" in the datacenter location for a correct visualization.

  • Google maps charges for map usage, see https://developers.google.com/maps/documentation/javascript/usage#usage_limits

Copyright © 2006-2024, Abiquo Holdings SL. All rights reserved