Revision as of 10:23, 27 December 2021

This page and the linked pages contains generic instructions for building on many Linux distributions.

Building GnuCash on Linux from the Source Code

Some Linux distributions may vary in specific details like:

• the package manager used to install software;
• the names of libraries and header files for compiling libraries;
• locations in which libraries and programs are commonly installed.

The instructions here use commands common to many (but not necessarily all) Debian/Ubuntu distributions. For other distributions, consult that distribution's documentation for the required information. For a list of package managers for common distributions and examples of their commands, see the Package Managers page.

Many distributions have a GUI software manager interfaces which can be used to manage installation. These are used to install the build tools and dependencies (libraries and development headers) needed to build GnuCash. If you are not familiar with the command syntax of your distribution's package manager, consult the man pages. See the Package Managers page for a listing of front ends on some Linux systems.

If you want to build and install GnuCash on Ubuntu there is a complete script to do this at the end of this page in the section 'Distribution Specific Issues'.

Setting up to Build GnuCash on Linux

To build GnuCash on a Linux system you will first have to have completed the following steps. Detailed instructions for each step are given on the linked pages.

1. Installing the Build Tools;
2. Getting the GnuCash sources;
3. Installing Google Test;
4. Installing Dependencies.

Building and Installing the GnuCash Program

The easy way to install most of GnuCash's dependencies is to use your package manager's build dependencies feature as root:

apt-get build-dep gnucash         # Debian based
yum-builddep gnucash              # RedHat based, but
dnf builddep gnucash              # Fedora (recent)
zypper source-install -d gnucash  # Opensuse

You can do the same for gnucash-docs.

Note

This will install the dependencies of your distributions version. If it is not from the 5.x branch, there may be a few changed dependencies which you will still have to resolve.

It is generally a good idea to uninstall any previous versions of GnuCash that you may have installed in the location into which you intend to install your new build. This will remove any unused files and may prevent interference by any previously installed GnuCash files and libraries. See #Uninstalling Gnucash.

Best practice with CMake requires use of a separate build directory. This may be placed either:

1. inside the top level source directory,
2. at the same level in the parent directory as the top level source directory (gnucash-4.<x>) or
3. at any other suitable location within your home directory.

Note: Some problems have been experienced with some libraries (not currently used in GnuCash but used in the documentation) when the build directory is placed within the top level "gnucash" or gnucash-4.x" source directory.

Locations to which GnuCash may be installed

The choosen path is stored as ${PREFIX} in the build environment.

System wide multiuser installation locations

Installation for system wide use by all users requires that the user doing the installation has an account with administrator privileges on the system (requires use of the sudo or su command to grant privileges). Locally installed software is normally installed with /usr/local as the base directory on Linux systems under the Linux File System Hierarchy. Software from the distribution software repository will normally install in this location so that it is unaffected by changes/updates to the system software which is normally located with /usr as the base directory. Usually software built on the system will be located under /opt as its base dircectory and packages installed in this location must have a directory labelled with the package name (or a registered provider name). (Some distributions may differ from this - if so consult the distribution documentation.)

Installation in a User's Home Directory for a Single User

Installation under the user's home directory is necessary for users who

do not have admin privileges and

cannot get a system administrator to install software for them.

The Linux File System Hierarchy does not specify any standard structures for users home directories. The Free Desktop Software Foundation maintains the XDG standard however this does not specify a location for local installation of software. Previously we have suggested installing GnuCash under the users .local hidden directory, /home/<user>/.local. This however conflicts with the use of /home/<user>/.local/share/gnucash to store user preference and customization data as the build also creates a gnucash directory in this location. For clarity we will use and recommend /home/<user>/opt in the following to parallel the /opt system location. This is the location recommended for inexperienced users with no or litle software building and installation experience on Linux systems. More experienced users may use any directory they like under their home directory.

Substitute <user> in the above and the following with the user's username on the computer on which GnuCash being installed. On most Linux systems the environmental variable HOME is defined as /home/<user> and can be used in commands in the terminal by prefixing it with $, i.e. using $HOME in a command will substitute /home/<user> into the command.

The cmake command syntax is cmake -D<install-target> <build-options> <build-source>. For further information see Cmake Build Directory Structure Options and Addressing.

1. <install-target> is the location to which you wish to install gnucash on your system (this is actually a build option but has been specified separately for clarity). The format is CMAKE_INSTALL_PREFIX=<value> where <value> is a path specification to an install location. Common locations are:
   1. /usr/local - this location is commonly used for installing locally built versions of applications that should be available to all users on the system. Some distributions may install the version of their software to this location instead of to /usr. If using this location, precede make install with sudo for admin privileges.
   2. /opt - this location is frequently used for user built software. (see comment for /usr/local regarding use of this location).
   3. $HOME/opt/gnucash - in your home directory. Requires adding $HOME/opt/gnucash/bin to $PATH environment variable. Use export PATH=$PATH:$HOME/opt/gnucash/bin at a shell prompt to set PATH for that shell. To make the changes to PATH permanent, you can add this command to the file .profile or the file .bashrc in your home directory (Note Other distributions may use different files for this purpose. Consult recommendations for your Linux distribution). $HOME is usually defined by default as /home/<user> where <user> is the logged in user name. If not enter export HOME=/home/<user> in the shell or add this command to /home/<user>/.profile (or .bashrc) to make it permanent.
2. <build-options> are 0 or more CMake option choices, blank separated, of the form -D <option> =<value> where <option> is one of the Gnucash Build Options for CMake. Currently the default GnuCash build includes all optional features except the Python bindings. Other options enable features like debugging information etc.
3. <build-source> is either an absolute reference to the top level gnucash-4.<x> directory or a relative reference to it from the build directory, where ever that is located. For the case illustrated below, <build-source> = ../gnucash-4.<x>;

Open a shell and change directory to the directory into which you extracted the GnuCash sources (gnucash-4.x) or cloned the github repository (gnucash), i.e. the parent directory of gnucash-4.<x> or gnucash.

Build using Cmake and Make

mkdir build-gnucash-4.<x>                 # create the build directory - Note: Named to identify the source since it is not necessarily within the source directory.
cd build-gnucash-4.<x>                    # change into the build directory
cmake -DCMAKE_INSTALL_PREFIX=$HOME/opt  ../gnucash-4.<x>     # As shown this will install in the opt directory in /home/<user>.  
make                                      # builds the program and associated libraries
make install                              # prefix with sudo if you do install to /usr/local or /opt as admin privileges are required.

Build using CMake and Ninja

mkdir build-gnucash-4.<x>                # create the build directory - Note: Named to identify the source since it is not within the source directory.
cd build-gnucash-4.<x>                   # change into the build directory
cmake -GNinja -DCMAKE_INSTALL_PREFIX=$HOME/opt ../gnucash-4.<x>     # As shown this will install in the opt directory in /home/<user>.  
ninja                                    # builds the program and associated libraries
ninja install                            # prefix with sudo if you do install to /usr/local or /opt as admin privileges are required.

Both ninja and make support a number of targets supplied as an argument to the command. Some of the more useful are:

Note: Information on current build issues with Linux distributions is available from #Distribution Specific Issues.

Configuration_Locations

For information on directories where configuration information for GnuCash is located for Linux, Windows and macOS follow the link in the heading.

Running GnuCash

Installed in /home/<user>/opt

To run GnuCash type in a shell

/home/<user>/opt/bin/gnucash

Alternatively you could use one of the following:

$HOME/opt/bin/gnucash       # HOME environment variable is usually defined on Linux systems.
~/opt/bin/gnucash           # "~" translates to /home/<user> on Linux systems. Note not portable on all systems and may not always be expanded

One could also define an alias for the path to the GnuCash executable to reduce the typing burden, e.g.:

alias gnucash="$HOME/opt/bin/gnucash"

Another alternative is to add the directory containing the GnuCash executable to the PATH environment variable. Edit "/home/<user>/.profile" with a text editor and add one of the following:

PATH=$PATH:$HOME/opt/bin      # your home directory will be searched after the system directories
PATH=$HOME/opt/bin:$PATH      # this will search your home directory before the system directories

Note: The right hand side in the above does not need to be quoted and "~" is not used because it may not expand correctly Another alternative is to use your system's menu editor to add a launcher for gnucash. This typically involves entering or selecting the path to the executable and providing a path to a suitable icon for display. The GnuCash icon is found at $HOME/opt/share/icons/hicolor/<nn>x<nn>/apps/gnucash-icon.png. Here <nn> is a 2 digit number giving the icon size (<nn> ={16,22,24,32,48,64,96,128,256}. There is also a scalable icon image in a scalable directory in addition to the <nn>x<nn> labelled directories.

Installed in /usr/local

/usr/local/bin is normally included in the PATH environment variable on most Linux systems. Type

echo $PATH

You can type the following at a shell prompt to execute GnuCash

gnucash

A menu launcher can besetup using your system's menu editor. Here you will only have to enter "gnucash" and not the full path. In this case the icon can be found at /usr/local/share/icons/hicolor/<nn>x<nn>/apps/gnucash-icon.png with <nn> = {16, 22, 24, 32, 48, 64, 96, 128, 256} as above.

Installed in /opt

In this case /opt is not normally included in the PATH environment variable. Often software installed here may be installed within a self named parent directory, e.g.

• /opt/gnucash

with subdirectories:

• /opt/gnucash/bin
• /opt/gnucash/lib
• /opt/gnucash/etc
• /opt/gnucash/share

into which the program components are stored. As described above in the $HOME/.local installation the program can be executed using the full path to the executable in a shell by typing:

/opt/gnucash/bin/gnucash

Again one can add the path to the executable to the PATH environment variable by adding:

PATH=$PATH:/opt/gnucash/bin  # search system paths first then /opt/gnucash/bin
PATH=/opt/gnucash/bin:$PATH  # search /opt/gnucash/bin before system paths

and then simply type gnucash at the prompt.

You may also setup a menu launcher using the menu editing process for the executable and an add icon as described above. Here the icons will be located in /opt/gnucash/share/icons/hicolor/<nn>x<nn>/apps/gnucash-icon.png

Uninstalling GnuCash

If you built GnuCash and you have retained the source directory and the build directory on your system, use the first set of instructions in Uninstall Gnucash Linux. The other sections list other methods for removing GnuCash depending upon how it was originally installed.

Distribution Specific Issues

Ubuntu

Impish Indri 21.10

The following bash script will install the required dependencies to build and install gnucash on Ubuntu 21.10. NOTE: you must open "Software and Updates" and make sure that "Source code" is ticked or this script will fail. This script will checkout and build version 4.9; change this to maint if you want the maintenance release, or to a different version number if you want a different version. This script will run through the whole process of building and installing and won't ask for confirmation.

## Ubuntu 21.10
## In "Software and Updates":
## Tick "Source code"
## Tick "Community-maintained free and open-source software (Universe)"

## Change this if you want to build it somewhere else.
SOURCEDIR="$HOME/Documents/gnucash/source"
BUILDDIR="$HOME/Documents/gnucash/build"

## Change this if you want to install it somewhere else
INSTALLDIR=/opt/gnucash

sudo apt -y update
sudo apt -y upgrade
sudo apt -y build-dep gnucash
sudo apt -y install git

mkdir -p $SOURCEDIR
mkdir -p $BUILDDIR

## Clone gnucash source from git
git clone https://github.com/Gnucash/gnucash.git $SOURCEDIR

## Checkout version 4.9
cd $SOURCEDIR
git checkout -b 4.9 4.9

cd $BUILDDIR
cmake -DCMAKE_INSTALL_PREFIX=$INSTALLDIR $SOURCEDIR

make
sudo make install

You can create a desktop icon for launching gnucash by saving the following to a file called gnucash-4.9.desktop (or gnucash-maint.desktop, or whatever)

[Desktop Entry]
Type=Application
Terminal=false
Exec=/opt/gnucash/bin/gnucash
Name=GnuCash 4.9
Comment=Manage home and small business accounts
Icon=/opt/gnucash/share/gnucash/pixmaps/gnucash-icon.ico

Keeping up with maint or the next release

Once you have installed the dependencies, as shown in the script above, and cloned the source from git, you can keep up with the maintenance release or the next release by using a simplified version of the script:

## Ubuntu 21.10

## Make sure these locations are the same as the ones you used above.
SOURCEDIR="$HOME/Documents/gnucash/source"
BUILDDIR="$HOME/Documents/gnucash/build"

## Change this if you want to install it somewhere else
INSTALLDIR=/opt/gnucash

# Make sure ubuntu is up-to-date
sudo apt -y update
sudo apt -y upgrade

## Get the latest source code changes from git
cd $SOURCEDIR
git pull

## Checkout maint (or whatever version you want)
git checkout -B maint maint

cd $BUILDDIR
cmake -DCMAKE_INSTALL_PREFIX=$INSTALLDIR $SOURCEDIR

make
sudo make install

Focal Fossa 20.04 LTS

(Also works for Linux Mint 20.2)

Could not find a package configuration file provided by "boost_program_options" (requested version 1.71.0) with any of the following names:
    boost_program_optionsConfig.cmake
    boost_program_options-config.cmake

apt-get install libboost-program-options1.71-dev

The following bash script will install the required dependencies to build and install gnucash on Ubuntu 20.04. NOTE: you must open "Software and Updates" and make sure that "Source code" is ticked or this script will fail. This script will checkout and build version 4.9; change this to maint if you want the maintenance release, or to a different version number if you want a different version. This script will run through the whole process of building and installing and won't ask for confirmation.

## Ubuntu 20.04
## In "Software and Updates":
## Tick "Source code"
## Tick "Community-maintained free and open-source software (Universe)"


## Change this if you want to build it somewhere else.
SOURCEDIR="$HOME/Documents/gnucash/source"
BUILDDIR="$HOME/Documents/gnucash/build"

## Change this if you want to install it somewhere else.
INSTALLDIR=/opt/gnucash

sudo apt -y update
sudo apt -y upgrade
sudo apt -y install git
sudo apt -y build-dep gnucash


## To build series 4 of gnucash on Ubuntu 20.04
sudo apt -y install libboost-program-options1.71-dev

mkdir -p $SOURCEDIR
mkdir -p $BUILDDIR

## Clone gnucash source from git
git clone https://github.com/Gnucash/gnucash.git $SOURCEDIR

## Checkout version 4.9
cd $SOURCEDIR
git checkout -B 4.9 4.9

cd $BUILDDIR
cmake -DCMAKE_INSTALL_PREFIX=$INSTALLDIR $SOURCEDIR

make
sudo make install

You can create a desktop icon for launching gnucash by saving the following to a file called gnucash-4.9.desktop (or gnucash-maint.desktop, or whatever)

[Desktop Entry]
Type=Application
Terminal=false
Exec=/opt/gnucash/bin/gnucash
Name=GnuCash 4.9
Comment=Manage home and small business accounts
Icon=/opt/gnucash/share/gnucash/pixmaps/gnucash-icon.ico

Keeping up with maint or the next release

Once you have installed the dependencies, as shown in the script above, and cloned the source from git, you can keep up with the maintenance release or the next release by using a simplified version of the script:

## Ubuntu 20.04

## Make sure these locations are the same as the ones you used above.
SOURCEDIR="$HOME/Documents/gnucash/source"
BUILDDIR="$HOME/Documents/gnucash/build"

## Change this if you want to install it somewhere else
INSTALLDIR=/opt/gnucash

# Make sure ubuntu is up-to-date
sudo apt -y update
sudo apt -y upgrade

## Get the latest source code changes from git
cd $SOURCEDIR
git pull

## Checkout maint (or whatever version you want)
git checkout -B maint maint

cd $BUILDDIR
cmake -DCMAKE_INSTALL_PREFIX=$INSTALLDIR $SOURCEDIR

make
sudo make install

Bionic Beaver 18.04

sudo apt install libwebkit2gtk-4.0-dev=2.20.1-1 libwebkit2gtk-4.0-37=2.20.1-1 gir1.2-webkit2-4.0=2.20.1-1 libjavascriptcoregtk-4.0-dev=2.20.1-1 gir1.2-javascriptcoregtk-4.0=2.20.1-1 libjavascriptcoregtk-4.0-18=2.20.1-1

In November 2018 a Stable Release Update updated the libwebkit2gtk-4.0-dev package so the workaround above should no longer be necessary (if your security updates have been applied). As of September 2019, the package has been updated again, so a fully updated Bionic should supply libwebkit2gtk-4.0-dev version 2.24.4-0ubuntu0.18.04.1