Advanced Installation Instructions

To install prebuilt Electron binaries, use npm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev

Смотри документацию к версиям Electron, чтобы узнать, как управлять версиями Electron в приложении.

Running Electron ad-hoc

If you're in a pinch and would prefer to not use npm install in your local project, you can also run Electron ad-hoc using the npx command runner bundled with npm:

npx electron .

The above command will run the current working directory with Electron. Note that any dependencies in your app will not be installed.

Настройка

Если хочешь изменить архитектуру загружаемого контента (например, i32 на компьютере с x64), можно использовать аргумент --arch при установке или использовать переменную окружения npm_config_arch:

npm install --arch=ia32 electron

Так же можно менять платформу приложения (например, win32 или linux) при помощи аргумента --platform:

npm install --platform=win32 electron

Прокси

If you need to use an HTTP proxy, you need to set the ELECTRON_GET_USE_PROXY variable to any value, plus additional environment variables depending on your host system's Node version:

• Node 10 and above
• Before Node 10

Пользовательские зеркала и кеши

Во время установки модуль electron будет обращаться к @electron/get, чтобы загрузить скомпилированные бинарники для твоей платформы, если она указана в списке релиза (https://github.com/electron/electron/releases/tag/v$VERSION, где $VERSION — версия Electron).

Если доступа к GitHub нет или нужна другая сборка, можно задать зеркало или папку кеша.

Зеркало

Можно использовать переменную окружения, чтобы переопределить базовый URL, по которому ищутся бинарники или имена файлов. The URL used by @electron/get is composed as follows:

url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME

For instance, to use the China CDN mirror:

ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"

By default, ELECTRON_CUSTOM_DIR is set to v$VERSION. To change the format, use the {{ version }} placeholder. For example, version-{{ version }} resolves to version-5.0.0, {{ version }} resolves to 5.0.0, and v{{ version }} is equivalent to the default. As a more concrete example, to use the China non-CDN mirror:

ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
ELECTRON_CUSTOM_DIR="{{ version }}"

The above configuration will download from URLs such as https://npmmirror.com/mirrors/electron/8.0.0/electron-v8.0.0-linux-x64.zip.

If your mirror serves artifacts with different checksums to the official Electron release you may have to set electron_use_remote_checksums=1 directly, or configure it in a .npmrc file, to force Electron to use the remote SHASUMS256.txt file to verify the checksum instead of the embedded checksums.

Кеш

Кроме того, можно заменить локальный кеш. @electron/get скачивает файлы в кеш, чтобы снизить нагрузку на сеть. Папку с кешем можно использовать для кастомных сборок или, чтобы полностью избежать сетевого трафика.

• Linux: $XDG_CACHE_HOME или ~/.cache/electron/
• macOS: ~/Library/Caches/electron/
• Windows: $LOCALAPPDATA/electron/Cache или ~/AppData/Local/electron/Cache/

В старом Electron возможно использование папки ~/.electron.

Также можно переопределить место кеша с помощью переменной окружения electron_config_cache.

The cache contains the version's official zip file as well as a checksum, and is stored as [checksum]/[filename]. A typical cache might look like this:

├── a91b089b5dc5b1279966511344b805ec84869b6cd60af44f800b363bba25b915
│   └── electron-v15.3.1-darwin-x64.zip

Skip binary download

Under the hood, Electron's JavaScript API binds to a binary that contains its implementations. Because this binary is crucial to the function of any Electron app, it is downloaded by default in the postinstall step every time you install electron from the npm registry.

However, if you want to install your project's dependencies but don't need to use Electron functionality, you can set the ELECTRON_SKIP_BINARY_DOWNLOAD environment variable to prevent the binary from being downloaded. For instance, this feature can be useful in continuous integration environments when running unit tests that mock out the electron module.

npm

ELECTRON_SKIP_BINARY_DOWNLOAD=1 npm install

Yarn

ELECTRON_SKIP_BINARY_DOWNLOAD=1 yarn install

Устранение проблем

При выполнении команды npm install electron, некоторые пользователи сталкиваются с проблемами установки.

В большинстве случаев, эти ошибки являются результатом проблем сети и не связаны с npm пакетом electron. Такие ошибки, как ELIFECYCLE, EAI_AGAIN, ECONNRESET иETIMEDOUT возникают в результате проблем с сетью. Лучшее решение - попытаться переключить сеть, или немного подождать, и попытаться установить снова.

Также вы можете попытаться скачать Electron непосредственно из electron/electron/releases, если установка через npm терпит неудачу.

Если установка завершается с ошибкой EACCESS, нужно поправить права npm.

Если ошибки не пропадают, можно использовать аргумент unsafe-perm:

sudo npm install electron --unsafe-perm=true

На слабой сети следует использовать аргумент --verbose, чтобы задействовать замедленную загрузку:

npm install --verbose electron

Если нужно перезагрузить файлы без кеша, нужно использовать переменную окружения force_no_cache = true.