Skip to content

Build-instructions.md

Latest commit

 

History

History
199 lines (155 loc) · 7.54 KB

Build-instructions.md

File metadata and controls

199 lines (155 loc) · 7.54 KB
Raw

Build instructions

NOTE: These instructions are for the master branch (Chrome 47).

There are two types of builds you can perform. You can build CEF Python using the prebuilt CEF binaries. Or you can build both CEF Python and CEF from sources. Building CEF is a long process that can take hours. In the tools/ directory there is the automate.py script that automates building CEF. However before you can run it you must satisfy some requirements.

Table of contents:

Requirements

Below are platform specific requirements. Do these first before following instructions in the "All platforms" section that lists requirements common for all platforms.

Windows

Linux

  • Install packages: sudo apt-get install cmake g++
  • If building CEF from sources:
    • Download and install cmake 2.8.12 or later (unless you already have a proper version, check with cmake --version): 
      cd build/
wget http://www.cmake.org/files/v2.8/cmake-2.8.12.2.tar.gz
tar xzf cmake-2.8.12.2.tar.gz
cd cmake-2.8.12.2
./configure
make
sudo make install
# restart terminal, so that new cmake is used
    • Download ninja 1.7.1 or later and copy it to /usr/bin and chmod 755.
    • When building CEF from sources you will need to install many more packages using the install-build-deps.sh script - instructions are provided further down on this page.
    • See also the Linux configuration for CEF automated builds on the cef/AutomatedBuildSetup.md wiki page.
  • Building on Ubuntu 12.04 is supported up to branch 2526 (Chrome 47). For branches 2623 (Chrome 49) or later Ubuntu 14.04+ is required.
  • To build on Debian 7 see cef/BuildingOnDebian7.md and cef/#1575, and cef/#1697
  • To perform a 32-bit Linux build on a 64-bit Linux system see cef/#1804
  • To build upstream cefclient/cefsimple you need to install these packages: sudo apt-get install libgtk2.0-dev libgtkglext1-dev

All platforms

  • Install dependencies for the automate.py tool by executing: cd tools/ && pip install -r requirements.txt. This will install some PyPI packages including Cython. On Windows installing Cython requires a VS compiler - see instructions above for Windows.

Build CEF Python using prebuilt CEF binaries

Prebuilt binaries are available on GitHub Releases and tagged eg. 'v47-upstream'.

Run the automate.py tool using the --prebuilt-cef flag that will download prebuilt binaries from GitHub Releases using version information from src/version/.

NOTE: The --prebuilt-cef flag is not implemented yet - you need to download manually from GitHub Releases and extract to cefpython/build/.

cd tools/
python automate.py --prebuilt-cef

You should be fine by running automate.py with the default options, but if you need to customize the build then use the --help flag to see more.

Build both CEF Python and CEF from sources

Run the automate.py tool using the --build-cef flag. Specify cef branch and optionally how many parallel ninja jobs to run (by default cores/2). If building on Linux see the Important note futher down.

cd tools/
python automate.py --build-cef --cef-branch 2526 --ninja-jobs 6

IMPORTANT NOTE (Linux): On Linux it will fail on first run. After the chromium sources are downloaded, it will try to build cef projects and fail due to missing packages. You will need to run the install-build-deps.sh script (intended for Ubuntu systems). When the "ttf-mscorefonts-installer" graphical installer pops up don't install it - deny EULA.

cd build/chromium/src/build/
chmod 755 install-build-deps.sh
sudo ./install-build-deps.sh --no-arm --no-chromeos-fonts --no-nacl

After dependencies are satisifed re-run automate.py.

You should be fine by running automate.py with the default options, but if you need to customize the build then use the --help flag to see more.

Build CEF manually

CEF Python official binaries come with custom CEF binaries with a few patches applied for our use case. These patches are in the patches/ directory.

On Linux before running any of CEF tools apply the issue73 patch first.

To build CEF follow the instructions on the Branches and Building CEF wiki page: https://bitbucket.org/chromiumembedded/cef/wiki/BranchesAndBuilding

After it is successfully built - apply patches, rebuild and remake distribs.

Note that CEF patches must be applied in the "download_dir/chromium/src/cef/" directory, not in the "download_dir/cef/" directory.

CEF automated builds

There are two sites that provide latest builds of CEF:

Official CEF Python binaries come with additional patches to CEF/Chromium, see the patches/ directory. Whether you need these patches depends on your use case, they may not be required and thus you could use the Spotify binaries. As of this writing there are three patches:

  • issue73 patch - tcmalloc issues, Spotify builds already apply it
  • issue125 patch - for https cache problems when using private certificates
  • issue218 patch - not required when running GTK or Kivy examples

How to patch

Create a patch from unstaged changes in current directory:

cd chromium/src/cef/
git diff --no-prefix --relative > cef.gyp.patch

Apply a patch in current directory:

cd chromium/src/cef/
git apply cef.gyp.patch