Appendix A: Building the Client
This section explains how to build the ownCloud Client from source for all major platforms. You should read this section if you want to develop for the desktop client. Build instructions are subject to change as development proceeds.
|Please check the version for which you want to build.|
These instructions are updated to work with the latest version of the ownCloud Client.
For the published desktop clients we link against QT5 dependencies from our own repositories so that we can have the same versions on all distributions. This chapter shows you how to build the client yourself with this setup. If you want to use the QT5 dependencies from your system, see the next chapter.
You may wish to use source packages for your Linux distribution, as these give you the exact sources from which the binary packages are built. These are hosted on the ownCloud repository from OBS. Go to the Index of repositories to see all the Linux client repositories.
To get the
The above registers the source repository of the released client. There is also
…/desktop:/testing/… and e.g.
…/desktop:/daily:/2.7/… for beta versions or daily snapshots.
Install the dependencies using the following commands for your specific Linux distribution. Make sure the repositories for source packages are enabled. These are:
Follow the generic build instructions, starting with step 2.
Build sources from a GitHub checkout with dependencies provided by your Linux distribution. While this allows more freedom for development, it does not exactly represent what we ship as packages. See above for how to recreate packages from source.
To get the source dependencies on Debian and Ubuntu, run the following command:
Follow the generic build instructions, starting with step 1.
In addition to needing Xcode (along with the command line tools), developing in the macOS environment requires extra dependencies. You can install these dependencies through MacPorts or Homebrew. These dependencies are required only on the build machine, because non-standard libs are deployed in the app bundle.
The tested and preferred way to develop in this environment is through the use of HomeBrew. The ownCloud team has its own repository containing non-standard recipes. To set up your build environment for development using HomeBrew:
Install Xcode command line tools using
Install Homebrew using
/usr/bin/ruby -e $(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install).
Add the ownCloud repository using the command
brew tap owncloud/owncloud
Install a Qt5 version, ideally from from 5.10.1, using the command
brew install qt5.
Install any missing dependencies, using the command:
brew install $(brew deps owncloud-client).
Install qtkeychain by running
git clone https://github.com/frankosterfeld/qtkeychain.git. Make sure you make the same install prefix as later while building the client e.g.,
For compilation of the client, follow the generic build instructions.
Install the Packages package creation tool.
In the build directory, run
admin/osx/create_mac.sh <CMAKE_INSTALL_DIR> <build dir> <installer sign identity>. If you have a developer signing certificate, you can specify its Common Name as a third parameter (use quotes) to have the package signed automatically.
Contrary to earlier versions, version 1.7 and later are packaged as a
pkginstaller. Do not call
make packageat any time when compiling for OS X, as this will build a disk image, which will not work correctly.
If you want to test some changes, you can build the ownCloud Client natively on Windows using KDE Craft. You can also use it to build unsupported and unoptimized installers.
|If you want to use Microsoft Visual Studio, naturally, that must be installed as well.|
When the dependencies are installed, install KDE Craft using the following lines in PowerShell:
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
The first command allows running scripts from remote sources.
The second command starts installing KDE Craft.
You are asked where you want to put the main folder, called
CraftRoot, which will contain all source, build, and install folders.
Please chose a disk with sufficient free space.
Last but not least, you need to chose the compiler you want to use.
The official builds only supports Microsoft Visual Studio 2019.
However, if you’re feeling adventurous, you can also try to use Mingw-w64.
In contrast to Visual Studio, which you need to install in advance, KDE Craft can install
Mingw-w64 for you.
|Unless you need 32bit builds, you should stick to the default of x64 builds.|
After you install KDE Craft, there are two steps left before the ownCloud Client can be compiled. These are:
To launch the KDE Craft environment, you need to run the following command in PowerShell. This provides you with a shell with all the environment variables set that you need to work with KDE Craft.
|This needs to be done every time you want to work with Craft.|
We’re assuming that you installed KDE Craft in the default path of
The last step before we can begin, is adding the ownCloud repository. It provides you with additional dependencies and tools, which are not available from the standard KDE repository.
craft --add-blueprint-repository https://github.com/owncloud/craft-blueprints-owncloud.git
|You only need to do this once.|
Finally we can build the client with the following command:
This installs all required dependencies and builds the ownCloud Client from the
master git branch.
If you want to build a different branch, first install all dependencies and then clone the source code from git, like this:
craft --install-deps owncloud-client craft --fetch owncloud-client
You can find the git checkout in
There you can use the usual git commands to switch branches and remotes, e.g., to build the
2.6 stable branch you can use craft with --set version parameter:
git checkout 2.6 craft --set version=2.6 owncloud-client
Afterwards you can build the client like this:
craft --configure --make --install craft owncloud-client
craft owncloud-client nor
craft --configure --make --install make the ownCloud Client available in your PATH, they only install to the so-called image directory.
This is so KDE Craft knows which files belong to which package.
In order to run the client, you first need to merge the image directory to the regular KDE Craft root (
Afterwards, you can run
owncloud.exe from your shell.
craft --qmerge owncloud-client owncloud.exe
Although this is not officially supported, it is, generally, possible to build an installer with:
craft nsis craft --package owncloud-client
Now you should have a file called:
This is not supported, optimised, nor regularly tested! Fully supported Windows installers are currently only provided by ownBrander.
To build the most up-to-date version of the client:
Clone the latest versions of the client from Git as follows:
git clone git://github.com/owncloud/client.git cd client # master this default, but you can also check out a tag like v2.5.4 git checkout master git submodule init git submodule update
Create the build directory:
mkdir client-build cd client-build
Configure the client build:
cmake -DCMAKE_PREFIX_PATH=/opt/ownCloud/qt-5.12.4 -DCMAKE_INSTALL_PREFIX=/Users/path/to/client/../install/ ..
For Linux builds (using QT5 libraries via build-dep) a typical setting is
-DCMAKE_PREFIX_PATH=/opt/ownCloud/qt-5.12.4/. However, the version number may vary. For Linux builds using system dependencies
-DCMAKE_PREFIX_PATHis not needed. You must use absolute paths for the
On Mac OS X, you need to specify
targetis a private location, i.e. in parallel to your build dir by specifying
qtkeychain must be compiled with the same prefix e.g.,
make. The ownCloud binary will appear in the
make installto install the client to the
/usr/local/bindirectory (or as per CMAKE_INSTALL_PREFIX).
The following are known CMake parameters:
QTKEYCHAIN_LIBRARY=/path/to/qtkeychain.dylib -DQTKEYCHAIN_INCLUDE_DIR=/path/to/qtkeychain/Used for stored credentials. When compiling with Qt5, the library is called
qt5keychain.dylib.You need to compile QtKeychain with the same Qt version. If you install QtKeychain into the CMAKE_PREFIX_PATH then you don’t need to specify the path manually.
WITH_DOC=TRUE: Creates doc and man pages through running
make; also adds install statements, providing the ability to install using
CMAKE_PREFIX_PATH=/path/to/Qt5.12.4/5.12.4/yourarch/lib/cmake/: Builds using that Qt version.
CMAKE_INSTALL_PREFIX=path: Set an install prefix. This is mandatory on Mac OS.
(Optional) Run a client that was installed in a custom CMAKE_INSTALL_PREFIX may not pick up the correct libraries automatically. You can use LD_LIBRARY_PATH to help finding the libraries like this:
If you don’t want to go through the trouble of doing all the compile work manually, you can use ownBrander to create installer images for all platforms.