Electron package guidelines
32-bit – CLR – Cross – Eclipse – Electron – Free Pascal – GNOME – Go – Haskell – Java – KDE – Kernel – Lisp – MinGW – Node.js – Nonfree – OCaml – Perl – PHP – Python – R – Ruby – Rust – VCS – Web – Wine
Using the system electron
Arch Linux provides globaland packages that can be used to run an electron application via a shellscript wrapper:
#!/bin/sh exec electron /path/to/appname/ "$@"
appname/ directory, or alternatively a file bundle called
appname.asar, can be found in a prebuilt electron application as the
resources/app/ folder (or
resources/app.asar). Everything else is just a copy of the electron runtime and can be removed from the final package.
Building compiled extensions against the system electron
Some electron applications have compiled native extensions which link to the electron runtime, and must be built using the correct electron version. Since npm/yarn will always build against a private prebuilt copy of electron, patch the electron dependency from
package.json to reference the same version as the system electron dependency. The build system will download the prebuilt copy it requires, compile the native extensions, and package everything into a final distribution, but this can be pruned during the
package() step as usual.
Alternatively, you can remove the electron dependency from
package.json and set the correct environment variables before running npm:
export npm_config_target=$(tail /usr/lib/electron/version) export npm_config_arch=x64 export npm_config_target_arch=x64 export npm_config_disturl=https://atom.io/download/electron export npm_config_runtime=electron export npm_config_build_from_source=true HOME="$srcdir/.electron-gyp" npm install
HOME to a path inside the
$srcdir so the build process doesn't place any files in your real
HOME directory. Make sure to adjust the path for all further commands that make use of the
(more details here).
Using electron-builder with system electron
package.json). This might not be desired if you want to use the system electron and save the bandwidth since you're going to throw away the electron binaries anyway. The electron-builder provides the configurations
electronVersion, to specify a custom path of Electron and the version the application is packaged for respectively.
Find the electron-builder configuration file (e.g.
electron-builder.json) and add the following settings:
electronVersionto the contents of
/usr/lib/electron/versionwithout the leading
Packages that apply this:AUR AUR
Alternatively you can use the CLI to change/add these settings like this:
./node_modules/.bin/electron-builder --linux --x64 --dir $dist -c.electronDist=$electronDist -c.electronVersion=$electronVer
Note that you have to specify all these options or it wont work.
Packages that apply this:AUR
An Electron package that contains compiled native extensions is architecture-dependent. Otherwise it is most likely architecture-independent.
If the package contains a prebuilt copy of electron, it is always architecture-dependent.
If the package is architecture-dependent, install the
resources/app/ directory to
/usr/lib/appname/. Otherwise use
If the package contains a prebuilt copy of electron, copy the final distribution in its entirety to