.. _building-label: 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. 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 ocsync) brew install $(brew deps mirall) bug: iniparser is not provideed by $(brew deps ocsync) fix with brew install iniparser To build mirall and csync, 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 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 with ``rpm -ivh `` (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 building ``libocsync``, you need to use ``mingw32-cmake`` instead of cmake. 2. for building ``mirall``, you need to use ``cmake`` again, but make sure to append the following parameter:: 3. Also, you need to specify *absolute pathes* for ``CSYNC_LIBRARY_PATH`` and ``CSYNC_LIBRARY_PATH`` when running ``cmake`` on mirall. ``-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 -------------------------- .. _`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 need ``iniparser``, ``sqlite3`` as well as ``neon`` for the ownCloud module. Take special care about ``neon``. If that is missing, the cmake run will succeed but silently not build the ownCloud module. ``libssh`` and ``libsmbclient`` are optional and not required for the client to work. If you want to install the client, run ``make install`` as 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, 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: * WITH_DOC=TRUE: create doc and manpages via running ``make``; also adds install statements to be able to install it via ``make install``. .. _`ownCloud repository from OBS`: http://software.opensuse.org/download/package?project=isv:ownCloud:devel&package=owncloud-client .. _CSync: http://www.csync.org .. _`Client Download Page`: http://owncloud.org/sync-clients/ .. _Git: http://git-scm.com .. _MacPorts: http://www.macports.org .. _Homebrew: http://mxcl.github.com/homebrew/