electron/docs/api/environment-variables.md

59 lines
1.4 KiB
Markdown
Raw Normal View History

2015-11-26 12:37:48 +00:00
# Environment variables
2016-04-21 22:39:12 +00:00
> Control application configuration and behavior without changing code.
2015-11-26 12:37:48 +00:00
Some behaviors of Electron are controlled by environment variables, because they
are initialized earlier than command line and the app's code.
2015-11-26 12:44:07 +00:00
Examples on POSIX shells:
```bash
$ export ELECTRON_ENABLE_LOGGING=true
$ electron
```
on Windows console:
```powershell
> set ELECTRON_ENABLE_LOGGING=true
> electron
```
2015-11-26 12:37:48 +00:00
## `ELECTRON_RUN_AS_NODE`
Starts the process as a normal Node.js process.
## `ELECTRON_ENABLE_LOGGING`
Prints Chrome's internal logging to console.
## `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.
2015-11-26 12:37:48 +00:00
## `ELECTRON_ENABLE_STACK_DUMPING`
When Electron crashed, prints the stack trace to console.
This environment variable will not work if `crashReporter` is started.
## `ELECTRON_DEFAULT_ERROR_MODE` _Windows_
Shows Windows's crash dialog when Electron crashed.
This environment variable will not work if `crashReporter` is started.
## `ELECTRON_NO_ATTACH_CONSOLE` _Windows_
Don't attach to current console session.
2015-11-26 12:37:48 +00:00
## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_
Don't use global menu bar on Linux.
## `ELECTRON_HIDE_INTERNAL_MODULES`
Turns off compatibility mode for old built-in modules like `require('ipc')`.