electron/docs/api/environment-variables.md

98 lines
2.8 KiB
Markdown
Raw Normal View History

2016-05-17 23:02:54 +00:00
# Environment Variables
2015-11-26 12:37:48 +00:00
2016-04-21 22:39:12 +00:00
> Control application configuration and behavior without changing code.
2016-05-20 21:03:28 +00:00
Certain Electron behaviors are controlled by environment variables because they
are initialized earlier than the command line flags and the app's code.
2015-11-26 12:37:48 +00:00
2016-05-20 21:03:56 +00:00
POSIX shell example:
2015-11-26 12:44:07 +00:00
2017-11-24 10:13:57 +00:00
```sh
2015-11-26 12:44:07 +00:00
$ export ELECTRON_ENABLE_LOGGING=true
$ electron
```
2016-05-20 21:03:56 +00:00
Windows console example:
2015-11-26 12:44:07 +00:00
```powershell
> set ELECTRON_ENABLE_LOGGING=true
> electron
```
2016-09-20 20:58:39 +00:00
## 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
2016-09-20 21:55:45 +00:00
process.env.GOOGLE_API_KEY = 'YOUR_KEY_HERE'
2016-09-20 20:58:39 +00:00
```
For instructions on how to acquire a Google API key, visit [this page](https://www.chromium.org/developers/how-tos/api-keys).
2016-09-20 21:13:30 +00:00
2016-09-20 20:58:39 +00:00
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).
2016-09-20 20:58:39 +00:00
2016-10-04 08:39:05 +00:00
### `ELECTRON_NO_ASAR`
Disables ASAR support. This variable is only supported in forked child processes
and spawned child processes that set `ELECTRON_RUN_AS_NODE`.
2016-10-04 08:39:05 +00:00
### `ELECTRON_RUN_AS_NODE`
Starts the process as a normal Node.js process.
### `ELECTRON_NO_ATTACH_CONSOLE` _Windows_
Don't attach to the current console session.
### `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_
Don't use the global menu bar on Linux.
2016-09-20 20:58:39 +00:00
## Development Variables
The following environment variables are intended primarily for development and
debugging purposes.
2015-11-26 12:37:48 +00:00
2016-05-20 20:58:48 +00:00
### `ELECTRON_ENABLE_LOGGING`
2015-11-26 12:37:48 +00:00
2016-05-20 21:01:08 +00:00
Prints Chrome's internal logging to the console.
2015-11-26 12:37:48 +00:00
2016-05-20 20:58:48 +00:00
### `ELECTRON_LOG_ASAR_READS`
2016-01-21 18:57:50 +00:00
When Electron reads from an ASAR file, log the read offset and file path to
the system `tmpdir`. The resulting file can be provided to the ASAR module
to optimize file ordering.
2016-05-20 20:58:48 +00:00
### `ELECTRON_ENABLE_STACK_DUMPING`
2015-11-26 12:37:48 +00:00
2016-05-20 21:02:10 +00:00
Prints the stack trace to the console when Electron crashes.
2015-11-26 12:37:48 +00:00
2016-05-20 21:01:08 +00:00
This environment variable will not work if the `crashReporter` is started.
2015-11-26 12:37:48 +00:00
2016-05-20 20:58:48 +00:00
### `ELECTRON_DEFAULT_ERROR_MODE` _Windows_
2015-11-26 12:37:48 +00:00
2016-05-20 21:01:08 +00:00
Shows the Windows's crash dialog when Electron crashes.
2015-11-26 12:37:48 +00:00
2016-05-20 21:01:08 +00:00
This environment variable will not work if the `crashReporter` is started.
### `ELECTRON_OVERRIDE_DIST_PATH`
When running from the `electron` package, this variable tells
the `electron` command to use the specified build of Electron instead of
the one downloaded by `npm install`. Usage:
```sh
export ELECTRON_OVERRIDE_DIST_PATH=/Users/username/projects/electron/out/Debug
```