| Current Path : /usr/share/doc/nextcloud-desktop/html/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : //usr/share/doc/nextcloud-desktop/html/building.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Appendix A: Building the Client — Nextcloud Client Manual 2.4.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Appendix B: History and Architecture" href="architecture.html" />
<link rel="prev" title="The Automatic Updater" href="autoupdate.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="architecture.html" title="Appendix B: History and Architecture"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="autoupdate.html" title="The Automatic Updater"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Client Manual</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="appendix-a-building-the-client">
<span id="building-label"></span><h1>Appendix A: Building the Client<a class="headerlink" href="#appendix-a-building-the-client" title="Permalink to this headline">¶</a></h1>
<p>This section explains how to build the Nextcloud Client from source for all
major platforms. You should read this section if you want to develop for the
desktop client.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Build instructions are subject to change as development proceeds.
Please check the version for which you want to build.</p>
</div>
<p>These instructions are updated to work with version 2.4.0 of the Nextcloud Client.</p>
<div class="section" id="getting-source-code">
<h2>Getting Source Code<a class="headerlink" href="#getting-source-code" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="#generic-build-instructions"><span class="std std-ref">Generic Build Instructions</span></a> pull the latest code directly from
GitHub, and work on Linux, macOS, and Windows.</p>
</div>
<div class="section" id="macos">
<h2>macOS<a class="headerlink" href="#macos" title="Permalink to this headline">¶</a></h2>
<p>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 <a class="reference external" href="http://www.macports.org">MacPorts</a> or <a class="reference external" href="http://mxcl.github.com/homebrew/">Homebrew</a>. These dependencies are required
only on the build machine, because non-standard libs are deployed in the app
bundle.</p>
<p>The tested and preferred way to develop in this environment is through the use
of <a class="reference external" href="http://mxcl.github.com/homebrew/">HomeBrew</a>. The team has its own repository containing non-standard
recipes.</p>
<p>To set up your build environment for development using <a class="reference external" href="http://mxcl.github.com/homebrew/">HomeBrew</a>:</p>
<ol class="arabic">
<li><p class="first">Install Xcode</p>
</li>
<li><dl class="first docutils">
<dt>Install Xcode command line tools::</dt>
<dd><p class="first last">xcode-select –install</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Install homebrew::</dt>
<dd><p class="first last">/usr/bin/ruby -e “$(curl -fsSL <a class="reference external" href="https://raw.githubusercontent.com/Homebrew/install/master/install">https://raw.githubusercontent.com/Homebrew/install/master/install</a>)”</p>
</dd>
</dl>
</li>
<li><p class="first">Add the Nextcloud repository using the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">brew</span> <span class="n">tap</span> <span class="n">owncloud</span><span class="o">/</span><span class="n">owncloud</span>
</pre></div>
</div>
</li>
<li><p class="first">Install a Qt5 version with qtwebkit support:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">brew</span> <span class="n">install</span> <span class="n">qt5</span> <span class="o">--</span><span class="k">with</span><span class="o">-</span><span class="n">qtwebkit</span>
</pre></div>
</div>
</li>
<li><p class="first">Install any missing dependencies:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>brew install $(brew deps owncloud-client)
</pre></div>
</div>
</li>
<li><p class="first">Add Qt from brew to the path:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export PATH=/usr/local/Cellar/qt5/5.x.y/bin:$PATH
</pre></div>
</div>
<p>Where <code class="docutils literal notranslate"><span class="pre">x.y</span></code> is the current version of Qt 5 that brew has installed
on your machine.</p>
</li>
<li><p class="first">Install qtkeychain from here: git clone <a class="reference external" href="https://github.com/frankosterfeld/qtkeychain.git">https://github.com/frankosterfeld/qtkeychain.git</a>
make sure you make the same install prefix as later while building the client e.g. -
<code class="docutils literal notranslate"><span class="pre">DCMAKE_INSTALL_PREFIX=/Path/to/client-install</span></code></p>
</li>
<li><p class="first">For compilation of the client, follow the <a class="reference internal" href="#generic-build-instructions"><span class="std std-ref">Generic Build Instructions</span></a>.</p>
</li>
<li><p class="first">Install the <a class="reference external" href="http://s.sudre.free.fr/Software/Packages/about.html">Packages</a> package creation tool.</p>
</li>
<li><p class="first">In the build directory, run <code class="docutils literal notranslate"><span class="pre">admin/osx/create_mac.sh</span> <span class="pre"><build_dir></span> <span class="pre"><install_dir></span></code>.
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.</p>
</li>
</ol>
<blockquote>
<div><div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Contrary to earlier versions, Nextcloud 1.7 and later are packaged
as a <code class="docutils literal notranslate"><span class="pre">pkg</span></code> installer. Do not call “make package” at any time when
compiling for OS X, as this will build a disk image, and will not
work correctly.</p>
</div>
</div></blockquote>
</div>
<div class="section" id="windows-development-build">
<h2>Windows Development Build<a class="headerlink" href="#windows-development-build" title="Permalink to this headline">¶</a></h2>
<p>If you want to test some changes and deploy them locally, you can build natively
on Windows using MinGW. If you want to generate an installer for deployment, please
follow <a class="reference internal" href="#windows-installer-build-cross-compile">Windows Installer Build (Cross-Compile)</a> instead.</p>
<ol class="arabic">
<li><p class="first">Get the required dependencies:</p>
<ul class="simple">
<li>Make sure that you have <a class="reference external" href="http://www.cmake.org/download">CMake</a> and <a class="reference external" href="http://git-scm.com">Git</a>.</li>
<li>Download the <a class="reference external" href="http://www.qt.io/download">Qt</a> MinGW package. You will use the MinGW version bundled with it.</li>
<li>Download an <a class="reference external" href="http://slproweb.com/products/Win32OpenSSL.html">OpenSSL Windows Build</a> (the non-“Light” version)</li>
</ul>
</li>
<li><p class="first">Get the <a class="reference external" href="https://github.com/frankosterfeld/qtkeychain">QtKeychain</a> sources as well as the latest versions of the Nextcloud client
from Git as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">frankosterfeld</span><span class="o">/</span><span class="n">qtkeychain</span><span class="o">.</span><span class="n">git</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">nextcloud</span><span class="o">/</span><span class="n">client</span><span class="o">.</span><span class="n">git</span>
</pre></div>
</div>
</li>
<li><p class="first">Open the Qt MinGW shortcut console from the Start Menu</p>
</li>
<li><p class="first">Make sure that OpenSSL’s <code class="docutils literal notranslate"><span class="pre">bin</span></code> directory as well as your qtkeychain source
directories are in your PATH. This will allow CMake to find the library and
headers, as well as allow the Nextcloud client to find the DLLs at runtime:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">PATH</span><span class="o">=</span><span class="n">C</span><span class="p">:</span>\<span class="o"><</span><span class="n">OpenSSL</span> <span class="n">Install</span> <span class="n">Dir</span><span class="o">></span>\<span class="nb">bin</span><span class="p">;</span><span class="o">%</span><span class="n">PATH</span><span class="o">%</span>
<span class="nb">set</span> <span class="n">PATH</span><span class="o">=</span><span class="n">C</span><span class="p">:</span>\<span class="o"><</span><span class="n">qtkeychain</span> <span class="n">Clone</span> <span class="n">Dir</span><span class="o">></span><span class="p">;</span><span class="o">%</span><span class="n">PATH</span><span class="o">%</span>
</pre></div>
</div>
</li>
<li><p class="first">Build qtkeychain <strong>directly in the source directory</strong> so that the DLL is built
in the same directory as the headers to let CMake find them together through PATH:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o"><</span><span class="n">qtkeychain</span> <span class="n">Clone</span> <span class="n">Dir</span><span class="o">></span>
<span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MinGW Makefiles"</span> <span class="o">.</span>
<span class="n">mingw32</span><span class="o">-</span><span class="n">make</span>
<span class="n">cd</span> <span class="o">..</span>
</pre></div>
</div>
</li>
<li><p class="first">Create the build directory:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">client</span><span class="o">-</span><span class="n">build</span>
<span class="n">cd</span> <span class="n">client</span><span class="o">-</span><span class="n">build</span>
</pre></div>
</div>
</li>
<li><p class="first">Build the client:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MinGW Makefiles"</span> <span class="o">../</span><span class="n">client</span>
<span class="n">mingw32</span><span class="o">-</span><span class="n">make</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You can try using ninja to build in parallel using
<code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">-G</span> <span class="pre">Ninja</span> <span class="pre">../client</span></code> and <code class="docutils literal notranslate"><span class="pre">ninja</span></code> instead.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Refer to the <a class="reference internal" href="#generic-build-instructions"><span class="std std-ref">Generic Build Instructions</span></a> section for additional options.</p>
</div>
<p>The Nextcloud binary will appear in the <code class="docutils literal notranslate"><span class="pre">bin</span></code> directory.</p>
</li>
</ol>
</div>
<div class="section" id="windows-installer-build-cross-compile">
<h2>Windows Installer Build (Cross-Compile)<a class="headerlink" href="#windows-installer-build-cross-compile" title="Permalink to this headline">¶</a></h2>
<p>Due to the large number of dependencies, building the client installer for Windows
is <strong>currently only officially supported on openSUSE</strong>, by using the MinGW cross compiler.
You can set up any currently supported version of openSUSE in a virtual machine if you do not
have it installed already.</p>
<p>In order to make setup simple, you can use the provided Dockerfile to build your own image.</p>
<ol class="arabic">
<li><p class="first">Assuming you are in the root of the Nextcloud Client’s source tree, you can
build an image from this Dockerfile like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">admin</span><span class="o">/</span><span class="n">win</span><span class="o">/</span><span class="n">docker</span>
<span class="n">docker</span> <span class="n">build</span> <span class="o">.</span> <span class="o">-</span><span class="n">t</span> <span class="n">nextcloud</span><span class="o">-</span><span class="n">client</span><span class="o">-</span><span class="n">win32</span><span class="p">:</span><span class="o"><</span><span class="n">version</span><span class="o">></span>
</pre></div>
</div>
<p>Replace <code class="docutils literal notranslate"><span class="pre"><version></span></code> by the version of the client you are building, e.g.
2.4.0 for the release of the client that this document describes.
If you do not wish to use docker, you can run the commands in <code class="docutils literal notranslate"><span class="pre">RUN</span></code> manually
in a shell, e.g. to create your own build environment in a virtual machine.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Docker images are specific to releases. This one refers to 2.4.0.
Newer releases may have different dependencies, and thus require a later
version of the docker image! Always pick the docker image fitting your release
of Nextcloud client!</p>
</div>
</li>
<li><p class="first">From within the source tree Run the docker instance:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>docker run -v "$PWD:/home/user/client" nextcloud-client-win32:<version> \
/home/user/client/admin/win/docker/build.sh client/ $(id -u)
</pre></div>
</div>
<p>It will run the build, create an NSIS based installer, as well as run tests.
You will find the resulting binary in an newly created <code class="docutils literal notranslate"><span class="pre">build-win32</span></code> subfolder.</p>
<p>If you do not wish to use docker, and ran the <code class="docutils literal notranslate"><span class="pre">RUN</span></code> commands above in a virtual machine,
you can run the indented commands in the lower section of <code class="docutils literal notranslate"><span class="pre">build.sh</span></code> manually in your
source tree.</p>
</li>
</ol>
<ol class="arabic" start="4">
<li><p class="first">Finally, you should sign the installer to avoid warnings upon installation.
This requires a <a class="reference external" href="https://msdn.microsoft.com/en-us/library/ie/ms537361%28v=vs.85%29.aspx">Microsoft Authenticode</a> Certificate <code class="docutils literal notranslate"><span class="pre">osslsigncode</span></code> to sign the installer:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>osslsigncode -pkcs12 $HOME/.codesign/packages.pfx -h sha256 \
-pass yourpass \
-n "ACME Client" \
-i "http://acme.com" \
-ts "http://timestamp.server/" \
-in ${unsigned_file} \
-out ${installer_file}
</pre></div>
</div>
<p>For <code class="docutils literal notranslate"><span class="pre">-in</span></code>, use the URL to the time stamping server provided by your CA along with the Authenticode certificate. Alternatively,
you may use the official Microsoft <code class="docutils literal notranslate"><span class="pre">signtool</span></code> utility on Microsoft Windows.</p>
<p>If you’re familiar with docker, you can use the version of <code class="docutils literal notranslate"><span class="pre">osslsigncode</span></code> that is part of the docker image.</p>
</li>
</ol>
</div>
<div class="section" id="generic-build-instructions">
<span id="id1"></span><h2>Generic Build Instructions<a class="headerlink" href="#generic-build-instructions" title="Permalink to this headline">¶</a></h2>
<p>Compared to previous versions, building the desktop sync client has become easier. Unlike
earlier versions, CSync, which is the sync engine library of the client, is now
part of the client source repository and not a separate module.</p>
<p>To build the most up-to-date version of the client:</p>
<ol class="arabic">
<li><p class="first">Clone the latest versions of the client from <a class="reference external" href="http://git-scm.com">Git</a> as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">nextcloud</span><span class="o">/</span><span class="n">client</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">client</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">init</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">update</span>
</pre></div>
</div>
</li>
<li><p class="first">Create the build directory:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">client</span><span class="o">-</span><span class="n">build</span>
<span class="n">cd</span> <span class="n">client</span><span class="o">-</span><span class="n">build</span>
</pre></div>
</div>
</li>
<li><p class="first">Configure the client build:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">DCMAKE_BUILD_TYPE</span><span class="o">=</span><span class="s2">"Debug"</span> <span class="o">..</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You must use absolute paths for the <code class="docutils literal notranslate"><span class="pre">include</span></code> and <code class="docutils literal notranslate"><span class="pre">library</span></code>
directories.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">On macOS, you need to specify <code class="docutils literal notranslate"><span class="pre">-DCMAKE_INSTALL_PREFIX=target</span></code>,
where <code class="docutils literal notranslate"><span class="pre">target</span></code> is a private location, i.e. in parallel to your build
dir by specifying <code class="docutils literal notranslate"><span class="pre">../install</span></code>.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">qtkeychain must be compiled with the same prefix e.g <code class="docutils literal notranslate"><span class="pre">CMAKE_INSTALL_PREFIX=/Users/path/to/client/install/</span> <span class="pre">.</span></code></p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Example:: <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">-DCMAKE_PREFIX_PATH=/usr/local/opt/qt5</span> <span class="pre">-DCMAKE_INSTALL_PREFIX=/Users/path/to/client/install/</span>  <span class="pre">-DNO_SHIBBOLETH=1</span></code></p>
</div>
</li>
<li><p class="first">Call <code class="docutils literal notranslate"><span class="pre">make</span></code>.</p>
<p>The Nextcloud binary will appear in the <code class="docutils literal notranslate"><span class="pre">bin</span></code> directory.</p>
</li>
<li><p class="first">(Optional) Call <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> to install the client to the
<code class="docutils literal notranslate"><span class="pre">/usr/local/bin</span></code> directory.</p>
</li>
</ol>
<p>The following are known cmake parameters:</p>
<ul class="simple">
<li><dl class="first docutils">
<dt><code class="docutils literal notranslate"><span class="pre">QTKEYCHAIN_LIBRARY=/path/to/qtkeychain.dylib</span> <span class="pre">-DQTKEYCHAIN_INCLUDE_DIR=/path/to/qtkeychain/</span></code>:</dt>
<dd>Used for stored credentials. When compiling with Qt5, the library is called <code class="docutils literal notranslate"><span class="pre">qt5keychain.dylib.</span></code>
You need to compile QtKeychain with the same Qt version.</dd>
</dl>
</li>
<li><code class="docutils literal notranslate"><span class="pre">WITH_DOC=TRUE</span></code>: Creates doc and manpages through running <code class="docutils literal notranslate"><span class="pre">make</span></code>; also adds install statements,
providing the ability to install using <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>.</li>
<li><code class="docutils literal notranslate"><span class="pre">CMAKE_PREFIX_PATH=/path/to/Qt5.2.0/5.2.0/yourarch/lib/cmake/</span></code>: Builds using Qt5.</li>
<li><code class="docutils literal notranslate"><span class="pre">BUILD_WITH_QT4=ON</span></code>: Builds using Qt4 (even if Qt5 is found).</li>
<li><code class="docutils literal notranslate"><span class="pre">CMAKE_INSTALL_PREFIX=path</span></code>: Set an install prefix. This is mandatory on Mac OS</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Appendix A: Building the Client</a><ul>
<li><a class="reference internal" href="#getting-source-code">Getting Source Code</a></li>
<li><a class="reference internal" href="#macos">macOS</a></li>
<li><a class="reference internal" href="#windows-development-build">Windows Development Build</a></li>
<li><a class="reference internal" href="#windows-installer-build-cross-compile">Windows Installer Build (Cross-Compile)</a></li>
<li><a class="reference internal" href="#generic-build-instructions">Generic Build Instructions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="autoupdate.html"
title="previous chapter">The Automatic Updater</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="architecture.html"
title="next chapter">Appendix B: History and Architecture</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/building.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="architecture.html" title="Appendix B: History and Architecture"
>next</a> |</li>
<li class="right" >
<a href="autoupdate.html" title="The Automatic Updater"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Client Manual</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013-2020, The Nextcloud developers.
Last updated on Mar 24, 2020.
</div>
</body>
</html>