環境変数

コードを変更せずにアプリケーションの設定と動作を制御します。

特定のElectronの動作は、コマンドラインフラグやアプリのコードよりも早く初期化されるため、環境変数によって制御されます。

POSIXシェルの例

$ export ELECTRON_ENABLE_LOGGING=true
$ electron

Windowsコンソールの例

> set ELECTRON_ENABLE_LOGGING=true
> electron

本番環境変数

以下の環境変数は、主にパッケージ化されたElectronアプリケーションの実行時に使用することを目的としています。

NODE_OPTIONS

Electronは、NodeのNODE_OPTIONSのサブセットをサポートしています。BoringSSLのChromiumでの使用と競合するものを除き、大部分がサポートされています。

例

export NODE_OPTIONS="--no-warnings --max-old-space-size=2048"

サポートされていないオプションは以下のとおりです。

--use-bundled-ca
--force-fips
--enable-fips
--openssl-config
--use-openssl-ca

NODE_OPTIONSは、パッケージ化されたアプリでは明示的に禁止されています。ただし、以下は例外です。

--max-http-header-size
--http-parser

nodeOptions fuseが無効になっている場合、NODE_OPTIONSは無視されます。

NODE_EXTRA_CA_CERTS

詳細については、Node.js cliドキュメントを参照してください。

export NODE_EXTRA_CA_CERTS=/path/to/cert.pem 

nodeOptions fuseが無効になっている場合、NODE_EXTRA_CA_CERTSは無視されます。

GOOGLE_API_KEY

Electronでのジオロケーションのサポートには、Google Cloud Platformのジオロケーションウェブサービスを使用する必要があります。この機能を有効にするには、Google APIキーを取得し、ジオロケーションリクエストを行うブラウザウィンドウを開く前に、メインプロセスファイルに次のコードを配置します。

process.env.GOOGLE_API_KEY = 'YOUR_KEY_HERE'

デフォルトでは、新しく生成されたGoogle APIキーはジオロケーションリクエストを行うことが許可されていない場合があります。プロジェクトのジオロケーションウェブサービスを有効にするには、APIライブラリから有効にします。

注意：ジオロケーションウェブサービスを機能させるには、APIキーに関連付けられているプロジェクトに請求先アカウントを追加する必要があります。

ELECTRON_NO_ASAR

ASARサポートを無効にします。この変数は、ELECTRON_RUN_AS_NODEを設定したフォークされた子プロセスおよびスポーンされた子プロセスでのみサポートされます。

ELECTRON_RUN_AS_NODE

プロセスを通常のNode.jsプロセスとして開始します。

このモードでは、通常のNode.js実行可能ファイルを実行する場合と同様に、cliオプションをNode.jsに渡すことができます。ただし、次のフラグは例外です。

• "--openssl-config"
• "--use-bundled-ca"
• "--use-openssl-ca"
• "--force-fips"
• "--enable-fips"

これらのフラグは、ElectronがNode.jsのcryptoモジュールを構築するときにOpenSSLの代わりにBoringSSLを使用しているため、設計どおりに機能しないという事実のために無効になっています。

runAsNode fuseが無効になっている場合、ELECTRON_RUN_AS_NODEは無視されます。

ELECTRON_NO_ATTACH_CONSOLE Windows

現在のコンソールセッションにアタッチしないでください。

ELECTRON_FORCE_WINDOW_MENU_BAR Linux

Linuxでグローバルメニューバーを使用しないでください。

ELECTRON_TRASH Linux

Linuxでゴミ箱の実装を設定します。デフォルトはgioです。

オプション

• gvfs-trash
• trash-cli
• kioclient5
• kioclient

ELECTRON_OZONE_PLATFORM_HINT Linux

Linuxで使用される優先プラットフォームバックエンドを選択します。デフォルトはx11です。autoは、可能であればWaylandを選択し、それ以外の場合はX11を選択します。

オプション

• auto
• wayland
• x11

開発環境変数

以下の環境変数は、主に開発およびデバッグを目的としています。

ELECTRON_ENABLE_LOGGING

Chromiumの内部ロギングをコンソールに出力します。

この変数を設定することは、コマンドラインで--enable-loggingを渡すことと同じです。詳細については、コマンドラインスイッチの--enable-loggingを参照してください。

ELECTRON_LOG_FILE

Chromiumの内部ロギングのファイル出力先を設定します。

この変数を設定することは、コマンドラインで--log-fileを渡すことと同じです。詳細については、コマンドラインスイッチの--log-fileを参照してください。

ELECTRON_DEBUG_NOTIFICATIONS

macOSでのNotificationライフサイクルにデバッグを支援するための追加ログを追加します。新しい通知が作成またはアクティブ化されると、追加のログが表示されます。また、一般的なアクションが実行されたときにも表示されます。通知が表示された、破棄された、ボタンがクリックされた、または返信されたとき。

出力例

Notification created (com.github.Electron:notification:EAF7B87C-A113-43D7-8E76-F88EC9D73D44)
Notification displayed (com.github.Electron:notification:EAF7B87C-A113-43D7-8E76-F88EC9D73D44)
Notification activated (com.github.Electron:notification:EAF7B87C-A113-43D7-8E76-F88EC9D73D44)
Notification replied to (com.github.Electron:notification:EAF7B87C-A113-43D7-8E76-F88EC9D73D44)

ELECTRON_LOG_ASAR_READS

ElectronがASARファイルから読み取るときに、読み取りオフセットとファイルパスをシステムのtmpdirにログ記録します。結果のファイルは、ファイル順序を最適化するためにASARモジュールに提供できます。

ELECTRON_ENABLE_STACK_DUMPING

Electronがクラッシュしたときに、スタックトレースをコンソールに出力します。

crashReporterが開始されている場合、この環境変数は機能しません。

ELECTRON_DEFAULT_ERROR_MODE Windows

Electronがクラッシュしたときに、Windowsのクラッシュダイアログを表示します。

crashReporterが開始されている場合、この環境変数は機能しません。

ELECTRON_OVERRIDE_DIST_PATH

electronパッケージから実行する場合、この変数は、electronコマンドに、npm installでダウンロードされたElectronではなく、指定されたElectronビルドを使用するように指示します。使用法

export ELECTRON_OVERRIDE_DIST_PATH=/Users/username/projects/electron/out/Testing

Electronによって設定

Electronは、実行時に環境にいくつかの変数を設定します。

ORIGINAL_XDG_CURRENT_DESKTOP

この変数は、アプリケーションが最初に起動したときのXDG_CURRENT_DESKTOPの値に設定されます。Electronは、Chromium内の他のロジックに影響を与えるためにXDG_CURRENT_DESKTOPの値を変更することがあるため、元の値にアクセスする場合は、代わりにこの環境変数を調べる必要があります。