Building WebKitGTK+

Getting the source

To get the WebKitGTK+ source, please follow the instructions on the ​WebKit page. Many WebKit developer also use git to interact with the repository and the WebKit developer tools have strong support for git. ​http://trac.webkit.org/wiki/UsingGitWithWebKit contains tips for using git with WebKit.

Dependencies

Note: Additional requirements may apply for running tests; see WebKitGtkLayoutTests.

1. Install the base WebKitGTK+ dependencies:

   $ sudo apt-get install autoconf \
                          automake \
                          autotools-dev \
                          bison \
                          flex \
                          gail-3.0 \
                          gawk \
                          gnome-common \
                          autopoint \
                          gperf \
                          ruby \
                          gtk-doc-tools \
                          libenchant-dev \
                          libgail-dev \
                          libgail-3-dev \
                          libgeoclue-dev \
                          libgirepository1.0-dev \
                          libgtk-3-dev \
                          libgstreamer-plugins-base0.10-dev \
                          libgudev-1.0-dev \
                          libicu-dev \
                          libgl1-mesa-glx \
                          libgl1-mesa-dev \
                          libjpeg62-dev \
                          libpango1.0-dev \
                          libpng12-dev \
                          libsqlite3-dev \
                          libtool \
                          libxslt1-dev \
                          libxt-dev \
                          libxtst-dev \
                          libgnutls-dev \
                          libvorbis-dev libtheora-dev libfaad-dev libmpg123-dev libpulse-dev libopus-dev \
                          libsecret-1-dev \
                          libwebp-dev \
                          intltool
   

2. Install the jhbuild module dependencies:

   $ sudo apt-get install gobject-introspection \
                          icon-naming-utils \
                          libgcrypt11-dev \
                          libgpg-error-dev \
                          libp11-kit-dev \
                          libtiff4-dev \
                          libcroco3-dev
   
   

3. Download and build all jhbuild modules:

   $ Tools/Scripts/update-webkitgtk-libs
   

Building WebKitGTK+

$ Tools/Scripts/build-webkit --gtk

Note: You can add --makeargs="-jXX", where XX is an integer, to set the number of threads make will use. The default is one per logical CPU detected, but you might want fewer if it's bogging down your system.

Notes

• JHBuild configuration and module files are stored as Tools/gtk/jhbuildrc and Tools/gtk/jhbuild.modules.
• If everything builds properly tests should typically pass on your system. Please file a bug if they do not.
• If you get build errors saying a library could not be found but you have the appropriate packages installed make sure you have up-to-date multiarch-support and binutils (or binutils-gold) packages

Extending the jhbuild environment

If for some reason you would like to have jhbuild build more modules, or simply newer versions of some of them - which is very useful if you are hacking Epiphany, you can extend the moduleset used by our jhbuild setup with a custom moduleset . To do that create your new moduleset file, set a couple environment variables (discussed bellow), and run ./Tools/Scripts/update-webkitgtk-libs to build and install your new modules. The file may look like this:

<?xml version="1.0"?>
<!DOCTYPE moduleset SYSTEM "moduleset.dtd">
<?xml-stylesheet type="text/xsl" href="moduleset.xsl"?>
<moduleset>

  <repository type="git" name="git.gnome.org"
      href="git://git.gnome.org/"/>
  <repository type="tarball" name="ftp.gnome.org"
      href="http://ftp.gnome.org"/>
  <repository type="git" name="entropywave"
      href="git://code.entropywave.com/git/"/>
  <repository type="git" name="gstreamer"
      href="git://anongit.freedesktop.org/git/gstreamer/"/>

  <autotools id="gtk+">
    <dependencies>
      <dep package="glib"/>
      <dep package="cairo"/>
    </dependencies>
    <branch module="/pub/GNOME/sources/gtk+/3.0/gtk+-3.3.10.tar.xz" version="3.3.10"
            repo="ftp.gnome.org"
            hash="sha256:9808d509bfd42fce692b041a60f3fbb668e43324613c304724e7a727bb44a2a0"
            md5sum="5872bacb3778c954d3cc0eaf9cdc53ab"/>
  </autotools>

  <autotools id="glib">
    <dependencies>
      <dep package="libffi"/>
    </dependencies>
    <branch module="/pub/GNOME/sources/glib/2.31/glib-2.31.8.tar.xz" version="2.31.8"
            repo="ftp.gnome.org"
            hash="sha256:1ce3d275189000e1c50e92efcdb6447bc260b1e5c41699b7a1959e3e1928fbaa"
            md5sum="6909664f29fae2f00cc3181c8c6a6aa7"/>
  </autotools>

  <autotools id="libsoup">
    <dependencies>
      <dep package="glib-networking"/>
    </dependencies>
    <branch module="libsoup" version="2.37.5"
            repo="git.gnome.org"
            tag="5eddf1a9d2e041de95012ece3cf97fbc2236306d"/>
  </autotools>

  <autotools id="orc">
    <branch repo="entropywave" module="orc" checkoutdir="orc" />
  </autotools>

  <autotools id="gstreamer">
    <branch repo="gstreamer" module="gstreamer" checkoutdir="gstreamer" />
  </autotools>

  <autotools id="gst-plugins-base" autogenargs="--disable-examples" makeargs="ERROR_CFLAGS=">
    <dependencies>
      <dep package="gstreamer"/>
      <dep package="orc"/>
    </dependencies>
    <branch repo="gstreamer" module="gst-plugins-base" checkoutdir="gst-plugins-base"/>
  </autotools>

  <autotools id="gst-plugins-good" autogenargs="--disable-examples">
    <dependencies>
      <dep package="gstreamer"/>
      <dep package="gst-plugins-base"/>
      <dep package="libsoup"/>
    </dependencies>
    <branch repo="gstreamer" module="gst-plugins-good" checkoutdir="gst-plugins-good"/>
  </autotools>

</moduleset>

To let the WebKit jhbuild environment know about the new files set the WEBKIT_EXTRA_MODULESETS to a ​file:// URI pointing to your file, like this:

$ export WEBKIT_EXTRA_MODULESETS=file:///home/user/my.modules

If you added new modules, set the WEBKIT_EXTRA_MODULES variable to a comma-separated list with their names. Please note: you have to run ./Tools/Scripts/update-webkitgtk-libs with these environment variables set for the modules to be taken into consideration.

Installation

To install the WebKit GTK+ library, simply change into the Release directory and issue

$ make install 

The configure script also supports the different features WebKit/GTK+ provide (e.g., SVG filters and animation features, HTML5 Video element support, etc..). Simply issuing

$ ./configure --help

on the command-line should give you a brief overview of what can be configured. Although you can build with these features enabled, it doesn't mean that the functionality is complete, let alone working properly. Feel free to submit a bug at ​http://bugs.webkit.org if you find something that is not working.

OS X

OS X: The code on Mac OS X should built like any Linux distribution, as long as you install the above build dependencies (in addition to an "ordinary build environment" that includes XCode Tools 2.3 or newer). ​MacPorts users can get the dependencies via:

$ sudo port install webkit-gtk

If you get an error about libjpeg when the build does the configuration step, you may find the following fixes it:

$ export CPPFLAGS="-I/opt/local/include"
$ export LDFLAGS="-L/opt/local/lib"