Follow the guidelines below for building Electron on Linux.
At least 25GB disk space and 8GB RAM.
Python 2.7.x. Some distributions like CentOS 6.x still use Python 2.6.x so you may need to check your Python version with
Please also ensure that your system and Python version support at least TLS 1.2. For a quick test, run the following script:
$ python ./script/tls.py
If the script returns that your configuration is using an outdated security protocol, use your system's package manager to update Python to the latest version in the 2.7.x branch. Alternatively, visit https://www.python.org/downloads/ for detailed instructions.
Node.js. There are various ways to install Node. You can download source code from nodejs.org and compile it. Doing so permits installing Node on your own home directory as a standard user. Or try repositories such as NodeSource.
clang 3.4 or later.
Development headers of GTK+ and libnotify.
On Ubuntu, install the following libraries:
$ sudo apt-get install build-essential clang libdbus-1-dev libgtk-3-dev \ libnotify-dev libgnome-keyring-dev libgconf2-dev \ libasound2-dev libcap-dev libcups2-dev libxtst-dev \ libxss1 libnss3-dev gcc-multilib g++-multilib curl \ gperf bison
On RHEL / CentOS, install the following libraries:
$ sudo yum install clang dbus-devel gtk3-devel libnotify-devel \ libgnome-keyring-devel xorg-x11-server-utils libcap-devel \ cups-devel libXtst-devel alsa-lib-devel libXrandr-devel \ GConf2-devel nss-devel
On Fedora, install the following libraries:
$ sudo dnf install clang dbus-devel gtk3-devel libnotify-devel \ libgnome-keyring-devel xorg-x11-server-utils libcap-devel \ cups-devel libXtst-devel alsa-lib-devel libXrandr-devel \ GConf2-devel nss-devel
Other distributions may offer similar packages for installation via package managers such as pacman. Or one can compile from source code.
$ git clone https://github.com/electron/electron
The bootstrap script will download all necessary build dependencies and create the build project files. You must have Python 2.7.x for the script to succeed. Downloading certain files can take a long time. Notice that we are using
ninja to build Electron so there is no
$ cd electron $ ./script/bootstrap.py --verbose
If you are using editor supports JSON compilation database based language server, you can generate it:
$ ./script/build.py --compdb
If you want to build for an
arm target you should also install the following dependencies:
$ sudo apt-get install libc6-dev-armhf-cross linux-libc-dev-armhf-cross \ g++-arm-linux-gnueabihf
arm64, install the following:
$ sudo apt-get install libc6-dev-arm64-cross linux-libc-dev-arm64-cross \ g++-aarch64-linux-gnu
And to cross-compile for
ia32 targets, you should pass the
--target_arch parameter to the
$ ./script/bootstrap.py -v --target_arch=arm
If you would like to build both
This script will cause a very large Electron executable to be placed in the directory
out/R. The file size is in excess of 1.3 gigabytes. This happens because the Release target binary contains debugging symbols. To reduce the file size, run the
This will put a working distribution with much smaller file sizes in the
dist directory. After running the
create-dist.py script, you may want to remove the 1.3+ gigabyte binary which is still in
You can also build the
Debug target only:
$ ./script/build.py -c D
After building is done, you can find the
electron debug binary under
To clean the build files:
$ npm run clean
To clean only
$ npm run clean-build
Note: Both clean commands require running
bootstrap again before building.
clang will try to link to
libtinfo.so.5. Depending on the host architecture, symlink to appropriate
$ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5
The default building configuration is targeted for major desktop Linux distributions. To build for a specific distribution or device, the following information may help you.
To avoid using the prebuilt binaries of
libchromiumcontent, you can build
libchromiumcontent locally. To do so, follow these steps:
$ git submodule update --init --recursive
$ ./script/bootstrap.py -v --build_release_libcc
Note that by default the
shared_library configuration is not built, so you can only build
Release version of Electron if you use this mode:
$ ./script/build.py -c R
clanginstead of downloaded
By default Electron is built with prebuilt
clang binaries provided by the Chromium project. If for some reason you want to build with the
clang installed in your system, you can call
--clang_dir=<path> switch. By passing it the build script will assume the
clang binaries reside in
For example if you installed
$ ./script/bootstrap.py -v --build_release_libcc --clang_dir /usr/local $ ./script/build.py -c R
To build Electron with compilers like
g++, you first need to disable
--disable_clang switch first, and then set
CXX environment variables to the ones you want.
For example building with GCC toolchain:
$ env CC=gcc CXX=g++ ./script/bootstrap.py -v --build_release_libcc --disable_clang $ ./script/build.py -c R
CXX, you can also set the following environment variables to customise the build configuration:
The environment variables have to be set when executing the
bootstrap.py script, it won't work in the
© 2013–2018 GitHub Inc.
Licensed under the MIT license.