Инструкции по Установке Расширенного Уровня

Для установки предварительно собранных бинарных файлов Electron используйте npm. Предпочтительный метод — установка Electron в качестве зависимости разработки в вашем приложении:

npm install electron --save-dev

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

Запуск Electron ad-hoc​

Если вам нужно быстрое решение и вы предпочитаете не использовать npm install в вашем локальном проекте, вы также можете запустить Electron ad-hoc, используя инструмент запуска команд npx, входящий в состав npm:

npx electron .

Вышеуказанная команда запустит текущую рабочую директорию с Electron. Обратите внимание, что любые зависимости вашего приложения не будут установлены.

Настройка​

Если вы хотите изменить архитектуру, которая загружается (например, ia32 на x64 машине), вы можете использовать флаг --arch с npm install или установить переменную среды npm_config_arch:

npm install --arch=ia32 electron

Помимо изменения архитектуры, вы также можете указать платформу (например, win32, linux, и т.д.) с помощью флага --platform:

npm install --platform=win32 electron

Прокси-серверы​

Если вам нужно использовать HTTP-прокси, вам нужно установить переменную ELECTRON_GET_USE_PROXY на любое значение, а также дополнительные переменные среды в зависимости от версии Node.js на вашей системе:

• Node 10 и выше
• Перед Node 10

Настройка зеркал и кэшей​

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

Если у вас нет доступа к GitHub или вам нужно предоставить собственный билд, вы можете сделать это, предоставив зеркало или существующую папку кэша.

Зеркало​

Вы можете использовать переменные среды для переопределения базового URL-адреса, пути для поиска бинарных файлов Electron и имени файла бинарника. URL-адрес, используемый @electron/get формируется следующим образом:

url = ELECTRON_MIRROR + ELECTRON_CUSTOM_DIR + '/' + ELECTRON_CUSTOM_FILENAME

Например, для использования зеркала China CDN:

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

По умолчанию, ELECTRON_CUSTOM_DIR установлено в значение v$VERSION. Чтобы изменить формат, используйте заполнитель {{ version }}. Например, version-{{ version }} разрешается в version-5.0.0, {{ version }} разрешается в 5.0.0, а v{{ version }} эквивалентен значению по умолчанию. Для использования зеркала China non-CDN:

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

Вышеуказанная конфигурация будет загружать файлы с таких URL-адресов, как https://npmmirror.com/mirrors/electron/8.0.0/electron-v8.0.0-linux-x64.zip.

Если ваше зеркало предоставляет артефакты с разными контрольными суммами по сравнению с официальным выпуском Electron, вам может потребоваться установить electron_use_remote_checksums=1 для принудительного использования удалённого файла SHASUMS256.txt для проверки контрольной суммы вместо встроенных контрольных сумм.

Кэш​

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

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

В средах, которые использовали более старые версии Electron, кэш может также находиться в ~/.electron.

Вы также можете переопределить расположение локального кэша, задав переменную среды electron_config_cache.

Кэш содержит официальный zip-файл версии, а также контрольную сумму и хранится как [checksum]/[filename]. Типичный кэш может выглядеть так:

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

Пропуск загрузки бинарных файлов​

Внутренне JavaScript API Electron связывается с бинарником, содержащим его реализации. Поскольку этот бинарник имеет решающее значение для работы любого приложения Electron, он загружается по умолчанию в шаге postinstall каждый раз, когда вы устанавливаете electron из реестра npm.

Однако, если вы хотите установить зависимости вашего проекта, но не нуждаетесь в функциональности Electron, вы можете установить переменную среды ELECTRON_SKIP_BINARY_DOWNLOAD для предотвращения загрузки бинарника. Эта функция может быть полезна в средах непрерывной интеграции при запуске модульных тестов, которые эмулируют модуль electron.

ELECTRON_SKIP_BINARY_DOWNLOAD=1 npm install

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 в значение true:

sudo npm install electron --unsafe-perm=true

В случае медленного интернет-соединения, рекомендуется использовать флаг --verbose для отображения прогресса загрузки:

npm install --verbose electron

Если вам нужно принудительно перескачать ресурс и файл SHASUM, установите переменную среды force_no_cache в значение true.