mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #7276 from electron/google-api-key-env2

Browse source 
allow GOOGLE_API_KEY to be set
This commit is contained in:
Cheng Zhao 2016-09-21 15:16:29 +09:00 • committed by GitHub
commit 805ce0dee9
3 changed files with 42 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/api/environment-variables.md
View file

@ -19,6 +19,35 @@ Windows console example:
> electron
```
## Production Variables
The following environment variables are intended primarily for use at runtime
in packaged Electron applications.
### `GOOGLE_API_KEY`
Electron includes a hardcoded API key for making requests to Google's geocoding
webservice. Because this API key is included in every version of Electron, it
often exceeds its usage quota. To work around this, you can supply your own
Google API key in the environment. Place the following code in your main process
file, before opening any browser windows that will make geocoding requests:
```javascript
process.env.GOOGLE_API_KEY = 'YOUR_KEY_HERE'
```
For instructions on how to acquire a Google API key, see
https://www.chromium.org/developers/how-tos/api-keys
By default, a newly generated Google API key may not be allowed to make
geocoding requests. To enable geocoding requests, visit this page:
https://console.developers.google.com/apis/api/geolocation/overview
## Development Variables
The following environment variables are intended primarily for development and
debugging purposes.
### `ELECTRON_RUN_AS_NODE`
Starts the process as a normal Node.js process.