nextcloud-desktop/doc/building.rst
Mario Enrico Ragucci 7e07d20d31 Remove LOG4C information as this is not needed anymore
Signed-off-by: Mario Enrico Ragucci <github@ragucci.de>
2013-04-26 13:32:35 +02:00

6.9 KiB

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.

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
  1. Follow the generic build instructions.

Mac OS X

Follow the generic build instructions.

You can install the missing 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 only exception to this rule is libiniparser, which lacks a decent build system. If you are using Homebrew, you can just add it:

brew tap dschmidt/owncloud
brew install iniparser

Otherwise, you need to copy the header and lib files to /usr/local/include and /usr/local/lib respectively.

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 that csync entails, building the client for Windows is currently only supported on openSUSE, by using the MinGW cross compiler. You can set up openSUSE 12.1 or 12.2 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):

```

zypper ar http://download.opensuse.org/repositories/isv:/ownCloud:/devel:/mingw:/win32/openSUSE_12.1/isv:ownCloud:devel:mingw:win32.repo zypper ar http://download.opensuse.org/repositories/windows:/mingw:/win32/openSUSE_12.1/windows:mingw:win32.repo zypper ar http://download.opensuse.org/repositories/windows:/mingw/openSUSE_12.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-iniparser-devel mingw32-libsqlite-devel mingw32-dlfcn-devel mingw32-libssh2-devel kdewin-png2ico mingw32-libqt4 mingw32-libqt4-devel mingw32-libgcrypt mingw32-libgnutls mingw32-libneon mingw32-libneon-devel mingw32-libbeecrypt mingw32-libopenssl mingw32-openssl mingw32-libpng-devel mingw32-libsqlite mingw32-qtkeychain mingw32-qtkeychain-devel mingw32-iniparser 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.. Usually, the following would be needed as well, but due to a bug in mingw, they will currently not build properly from source. mingw32-cross-nsis-plugin-processes mingw32-cross-nsis-plugin-uac You will also need to manually download and install the following files withrpm -ivh <package>(They will also work with OpenSUSE 12.2):: rpm -ihv http://pmbs.links2linux.org/download/mingw:/32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-processes-0-1.1.x86_64.rpm rpm -ihv http://pmbs.links2linux.org/download/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: 1. For buildinglibocsync, you need to usemingw32-cmakeinstead of cmake. 2. for buildingmirall, you need to usecmakeagain, but make sure to append the following parameter:: 3. Also, you need to specify *absolute pathes* forCSYNC_LIBRARY_PATHandCSYNC_LIBRARY_PATHwhen runningcmakeon mirall.-DCMAKE_TOOLCHAIN_FILE=../mirall/admin/win/Toolchain-mingw32-openSUSE.cmakeFinally, just build by runningmake.make packagewill produce an NSIS-based installer, provided the NSIS mingw32 packages are installed. Generic Build Instructions -------------------------- .. _`generic build instructions` The ownCloud Client requires Mirall and CSync_. Mirall is the GUI frontend, while CSync is responsible for handling the actual synchronization process. At the moment, ownCloud Client requires a forked version of CSync. Both CMake and 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 and CSync via Git_, like so:: git clone git://git.csync.org/users/freitag/csync.git ocsync git clone git://github.com/owncloud/mirall.git Next, create build directories:: mkdir ocsync-build mkdir mirall-build This guide assumes that all directories are residing next to each other. Next, make sure to check out the 'dav' branch in the newly checked out `ocsync` directory:: cd ocsync git checkout dav The first package to build is CSync:: cd ocsync-build cmake -DCMAKE_BUILD_TYPE="Debug" ../ocsync make You probably have to satisfy some dependencies. Make sure to install all the needed development packages. You will neediniparser,sqlite3as well asneonfor the ownCloud module. Take special care aboutneon. If that is missing, the cmake run will succeed but silently not build the ownCloud module.libsshandlibsmbclientare optional and not required for the client to work. If you want to install the client, runmake installas a final step. Next, we build mirall:: cd ../mirall-build cmake -DCMAKE_BUILD_TYPE="Debug" ../mirall \ -DCSYNC_BUILD_PATH=/path/to/ocsync-build \ -DCSYNC_INCLUDE_PATH=/path/to/ocsync/src Note that it is important to use absolute pathes for the include- and library directories. If this succeeds, callmake. The owncloud binary should appear in thebindirectory. You can also runmake installto install the client to/usr/local/bin. To build in installer (requires the mingw32-cross-nsis packages):: make package Known cmake parameters: * WITH_DOC=TRUE: create doc and manpages via runningmake; also adds install statements to be able to install it viamake install``.