nextcloud-desktop/doc/building.rst

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 development on the desktop client.

Note that the building instruction are subject to change as development proceeds. It is important to check the version which is to built.

This instructions were updated to work with ownCloud Client 1.5.

Linux

1. Add the ownCloud repository from OBS.
2. Install the dependencies (as root, or via sudo):

• Debian/Ubuntu: apt-get update; apt-get build-dep owncloud-client
• openSUSE: zypper ref; zypper si -d owncloud-client
• Fedora/CentOS: yum install yum-utils; yum-builddep owncloud-client

3. Follow the generic build instructions.

Mac OS X

Next to XCode (and the command line tools!), you will need some extra dependencies.

You can install these dependencies via MacPorts or Homebrew. This is only needed on the build machine, since non-standard libs will be deployed in the app bundle.

The tested and preferred way is to use HomeBrew. The ownCloud team has its own repository which contains non-standard recipes. Add it with:

brew tap owncloud/owncloud

Next, install the missing dependencies:

brew install $(brew deps mirall)

To build mirall, follow the generic build instructions.

Note

You should not call make install at any time, since the product of the mirall build is an app bundle. Call make package instead to create an install-ready disk image.

Windows (cross-compile)

Due to the amount of dependencies, building the client for Windows is currently only supported on openSUSE, by using the MinGW cross compiler. You can set up openSUSE 12.1, 12.2 or 13.1 in a virtual machine if you do not have it installed already.

In order to cross-compile, the following repositories need to be added via YaST or zypper ar (adjust when using openSUSE 12.2 or 13.1):

zypper ar http://download.opensuse.org/repositories/windows:/mingw:/win32/openSUSE_13.1/windows:mingw:win32.repo
zypper ar http://download.opensuse.org/repositories/windows:/mingw/openSUSE_13.1/windows:mingw.repo

Next, install the cross-compiler packages and the cross-compiled dependencies:

zypper install cmake make mingw32-cross-binutils mingw32-cross-cpp mingw32-cross-gcc \
               mingw32-cross-gcc-c++ mingw32-cross-pkg-config mingw32-filesystem \
               mingw32-headers mingw32-runtime site-config mingw32-libqt4-sql \
               mingw32-libqt4-sql-sqlite mingw32-sqlite mingw32-libsqlite-devel \
               mingw32-dlfcn-devel mingw32-libssh2-devel kdewin-png2ico \
               mingw32-libqt4 mingw32-libqt4-devel mingw32-libgcrypt \
               mingw32-libgnutls mingw32-libneon-openssl mingw32-libneon-devel \
               mingw32-libbeecrypt mingw32-libopenssl mingw32-openssl \
               mingw32-libpng-devel mingw32-libsqlite mingw32-qtkeychain \
               mingw32-qtkeychain-devel mingw32-dlfcn mingw32-libintl-devel \
               mingw32-libneon-devel mingw32-libopenssl-devel mingw32-libproxy-devel \
               mingw32-libxml2-devel mingw32-zlib-devel

For the installer, the NSIS installer package is also required:

zypper install mingw32-cross-nsis

You will also need to manually download and install the following files with rpm -ivh <package> (They will also work with openSUSE 12.2 and newer):

rpm -ihv http://download.tomahawk-player.org/packman/mingw:32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-processes-0-1.1.x86_64.rpm
rpm -ihv http://download.tomahawk-player.org/packman/mingw:32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-uac-0-3.1.x86_64.rpm

Now, follow the generic build instructions, but pay attention to the following differences:

For building for windows a special toolchain file has to be specified. That makes cmake finding the platform specific tools. This parameter has to be added to the call to cmake:

-DCMAKE_TOOLCHAIN_FILE=../mirall/admin/win/Toolchain-mingw32-openSUSE.cmake

Finally, just build by running make. make package will produce an NSIS-based installer, provided the NSIS mingw32 packages are installed.

Generic Build Instructions

Compared to previous versions building of Mirall has become more easy. CSync, which is the sync engine library of Mirall, is now part of the Mirall source repository, not, like it was before, a separate module.

Mirall can be downloaded at ownCloud's Client Download Page.

If you want to build the leading edge version of the client, you should use the latest versions of Mirall via Git, like so:

git clone git://github.com/owncloud/mirall.git

Next, create build directories:

mkdir mirall-build

Now build mirall:

cd ../mirall-build
cmake -DCMAKE_BUILD_TYPE="Debug" ../mirall

Note that it is important to use absolute pathes for the include- and library directories. If this succeeds, call make. The owncloud binary should appear in the bin directory. You can also run make install to install the client to /usr/local/bin.

To build an installer/app bundle (requires the mingw32-cross-nsis packages on Windows):

make package

Known cmake parameters:

• QTKEYCHAIN_LIBRARY=/path/to/qtkeychain.dylib -DQTKEYCHAIN_INCLUDE_DIR=/path/to/qtkeychain/: Use QtKeychain for stored credentials. When compiling with Qt5, the library is called qt5keychain.dylib. You need to compile QtKeychain with the same Qt version.
• WITH_DOC=TRUE: create doc and manpages via running make; also adds install statements to be able to install it via make install.
• CMAKE_PREFIX_PATH=/path/to/Qt5.2.0/5.2.0/yourarch/lib/cmake/ : to build with Qt5
• BUILD_WITH_QT4=ON : to build with Qt4 even if Qt5 is found