| 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/advancedusage.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>Advanced Usage — 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="The Automatic Updater" href="autoupdate.html" />
<link rel="prev" title="Conflicts" href="conflicts.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="autoupdate.html" title="The Automatic Updater"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="conflicts.html" title="Conflicts"
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="advanced-usage">
<h1>Advanced Usage<a class="headerlink" href="#advanced-usage" title="Permalink to this headline">¶</a></h1>
<div class="section" id="options">
<span id="index-0"></span><h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p id="index-1">You have the option of starting your Nextcloud desktop client with the
<code class="docutils literal notranslate"><span class="pre">nextcloud</span></code> command. The following options are supported:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">nextcloud</span> <span class="pre">-h</span></code> or <code class="docutils literal notranslate"><span class="pre">nextcloud</span> <span class="pre">--help</span></code></dt>
<dd>Displays all command options.</dd>
</dl>
<p>The other options are:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">--logwindow</span></code></dt>
<dd>Opens a window displaying log output.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--logfile</span></code> <cite><filename></cite></dt>
<dd>Write log output to the file specified. To write to stdout, specify <cite>-</cite>
as the filename.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--logdir</span></code> <cite><name></cite></dt>
<dd>Writes each synchronization log output in a new file in the specified
directory.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--logexpire</span></code> <cite><hours></cite></dt>
<dd>Removes logs older than the value specified (in hours). This command is
used with <code class="docutils literal notranslate"><span class="pre">--logdir</span></code>.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--logflush</span></code></dt>
<dd>Clears (flushes) the log file after each write action.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--logdebug</span></code></dt>
<dd>Also output debug-level messages in the log (equivalent to setting the env var QT_LOGGING_RULES=”qt.*=true;*.debug=true”).</dd>
</dl>
<p>)</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">--confdir</span></code> <cite><dirname></cite></dt>
<dd>Uses the specified configuration directory.</dd>
</dl>
</div>
<div class="section" id="configuration-file">
<h2>Configuration File<a class="headerlink" href="#configuration-file" title="Permalink to this headline">¶</a></h2>
<p id="index-2">The Nextcloud Client reads a configuration file. You can locate this configuration file as follows:</p>
<dl class="docutils">
<dt>On Linux distributions:</dt>
<dd><code class="docutils literal notranslate"><span class="pre">$HOME/.config/Nextcloud/nextcloud.cfg</span></code></dd>
<dt>On Microsoft Windows systems:</dt>
<dd><code class="docutils literal notranslate"><span class="pre">%APPDATA%\Nextcloud\nextcloud.cfg</span></code></dd>
<dt>On macOS systems:</dt>
<dd><code class="docutils literal notranslate"><span class="pre">$HOME/Library/Preferences/Nextcloud/nextcloud.cfg</span></code></dd>
</dl>
<p>The configuration file contains settings using the Microsoft Windows .ini file
format. You can overwrite changes using the Nextcloud configuration dialog.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Use caution when making changes to the Nextcloud Client configuration
file. Incorrect settings can produce unintended results.</p>
</div>
<p>Some interesting values that can be set on the configuration file are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="10%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head" colspan="3"><code class="docutils literal notranslate"><span class="pre">[Nextcloud]</span></code> section</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Variable</td>
<td>Default</td>
<td>Meaning</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">remotePollInterval</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">30000</span></code></td>
<td>Specifies the poll time for the remote repository in milliseconds.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">forceSyncInterval</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">7200000</span></code></td>
<td>The duration of no activity after which a synchronization run shall be triggered automatically.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fullLocalDiscoveryInterval</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">3600000</span></code></td>
<td>The interval after which the next synchronization will perform a full local discovery.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">notificationRefreshInterval</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">300000</span></code></td>
<td>Specifies the default interval of checking for new server notifications in milliseconds.</td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="10%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head" colspan="3"><code class="docutils literal notranslate"><span class="pre">[General]</span></code> section</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Variable</td>
<td>Default</td>
<td>Meaning</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">chunkSize</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">5242880</span></code></td>
<td>Specifies the chunk size of uploaded files in bytes.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">promptDeleteAllFiles</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">true</span></code></td>
<td>If a UI prompt should ask for confirmation if it was detected that all files and folders were deleted.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxLogLines</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">20000</span></code></td>
<td>Specifies the maximum number of log lines displayed in the log window.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">timeout</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">300</span></code></td>
<td>The timeout for network connections in seconds.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">moveToTrash</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">false</span></code></td>
<td>If non-locally deleted files should be moved to trash instead of deleting them completely.
This option only works on linux</td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="10%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head" colspan="3"><code class="docutils literal notranslate"><span class="pre">[Proxy]</span></code> section</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Variable</td>
<td>Default</td>
<td>Meaning</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">host</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code></td>
<td>The address of the proxy server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">port</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">8080</span></code></td>
<td>The port were the proxy is listening.</td>
</tr>
<tr class="row-odd"><td rowspan="4"><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
<td rowspan="4"><code class="docutils literal notranslate"><span class="pre">2</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">0</span></code> for System Proxy.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">1</span></code> for SOCKS5 Proxy.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">2</span></code> for No Proxy.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">3</span></code> for HTTP(S) Proxy.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="environment-variables">
<h2>Environment Variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2>
<p id="index-3">The behavior of the client can also be controlled using environment variables. The value of the environment variables overrides the values in the configuration file.</p>
<p>The environment variables are:</p>
<ul class="simple">
<li><cite>OWNCLOUD_CHUNK_SIZE</cite> (default: 5242880; 5 MiB) – Specifies the chunk size of uploaded files in bytes. Increasing this value may help with synchronization problems in certain configurations.</li>
<li><cite>OWNCLOUD_TIMEOUT</cite> (default: 300 s) – The timeout for network connections in seconds.</li>
<li><cite>OWNCLOUD_CRITICAL_FREE_SPACE_BYTES</cite> (default: 50*1000*1000 bytes) - The minimum disk space needed for operation. A fatal error is raised if less free space is available.</li>
<li><cite>OWNCLOUD_FREE_SPACE_BYTES</cite> (default: 250*1000*1000 bytes) - Downloads that would reduce the free space below this value are skipped. More information available under the “Low Disk Space” section.</li>
<li><cite>OWNCLOUD_MAX_PARALLEL</cite> (default: 6) - Maximum number of parallel jobs.</li>
<li><cite>OWNCLOUD_BLACKLIST_TIME_MIN</cite> (default: 25 s) - Minimum timeout for blacklisted files.</li>
<li><cite>OWNCLOUD_BLACKLIST_TIME_MAX</cite> (default: 24*60*60 s; one day) - Maximum timeout for blacklisted files.</li>
</ul>
</div>
<div class="section" id="nextcloud-command-line-client">
<h2>Nextcloud Command Line Client<a class="headerlink" href="#nextcloud-command-line-client" title="Permalink to this headline">¶</a></h2>
<p id="index-4">The Nextcloud Client packages contain a command line client, <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code>, that can
be used to synchronize Nextcloud files to client machines.</p>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> performs a single <em>sync run</em> and then exits the synchronization
process. In this manner, <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> processes the differences between
client and server directories and propagates the files to bring both
repositories to the same state. Contrary to the GUI-based client,
<code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> does not repeat synchronizations on its own. It also does not
monitor for file system changes.</p>
<p>To invoke <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code>, you must provide the local and the remote repository
URL using the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">nextcloudcmd</span> <span class="p">[</span><span class="n">OPTIONS</span><span class="o">...</span><span class="p">]</span> <span class="n">sourcedir</span> <span class="n">nextcloudurl</span>
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre">sourcedir</span></code> is the local directory and <code class="docutils literal notranslate"><span class="pre">nextcloudurl</span></code> is
the server URL.</p>
<p>Other command line switches supported by <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> include the following:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">--user</span></code>, <code class="docutils literal notranslate"><span class="pre">-u</span></code> <code class="docutils literal notranslate"><span class="pre">[user]</span></code></dt>
<dd>Use <code class="docutils literal notranslate"><span class="pre">user</span></code> as the login name.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--password</span></code>, <code class="docutils literal notranslate"><span class="pre">-p</span></code> <code class="docutils literal notranslate"><span class="pre">[password]</span></code></dt>
<dd>Use <code class="docutils literal notranslate"><span class="pre">password</span></code> as the password.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-n</span></code></dt>
<dd>Use <code class="docutils literal notranslate"><span class="pre">netrc</span> <span class="pre">(5)</span></code> for login.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--non-interactive</span></code></dt>
<dd>Do not prompt for questions.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--silent</span></code>, <code class="docutils literal notranslate"><span class="pre">--s</span></code></dt>
<dd>Inhibits verbose log output.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--trust</span></code></dt>
<dd>Trust any SSL certificate, including invalid ones.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--httpproxy</span>  <span class="pre">http://[user@pass:]<server>:<port></span></code></dt>
<dd>Uses <code class="docutils literal notranslate"><span class="pre">server</span></code> as HTTP proxy.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--nonshib</span></code></dt>
<dd>Uses Non Shibboleth WebDAV Authentication</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--davpath</span> <span class="pre">[path]</span></code></dt>
<dd>Overrides the WebDAV Path with <code class="docutils literal notranslate"><span class="pre">path</span></code></dd>
<dt><code class="docutils literal notranslate"><span class="pre">--exclude</span> <span class="pre">[file]</span></code></dt>
<dd>Exclude list file</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--unsyncedfolders</span> <span class="pre">[file]</span></code></dt>
<dd>File containing the list of un-synced remote folders (selective sync)</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--max-sync-retries</span> <span class="pre">[n]</span></code></dt>
<dd>Retries maximum n times (defaults to 3)</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-h</span></code></dt>
<dd>Sync hidden files, do not ignore them</dd>
</dl>
<div class="section" id="credential-handling">
<h3>Credential Handling<a class="headerlink" href="#credential-handling" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> requires the user to specify the username and password using the standard URL pattern, e.g.,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ nextcloudcmd /home/user/my_sync_folder https://carla:secret@server/nextcloud/remote.php/webdav/
</pre></div>
</div>
<p>To synchronize the Nextcloud directory <code class="docutils literal notranslate"><span class="pre">Music</span></code> to the local directory
<code class="docutils literal notranslate"><span class="pre">media/music</span></code>, through a proxy listening on port <code class="docutils literal notranslate"><span class="pre">8080</span></code>, and on a gateway
machine using IP address <code class="docutils literal notranslate"><span class="pre">192.168.178.1</span></code>, the command line would be:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ nextcloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \
https://server/nextcloud/remote.php/webdav/Music
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> will prompt for the user name and password, unless they have
been specified on the command line or <code class="docutils literal notranslate"><span class="pre">-n</span></code> has been passed.</p>
</div>
<div class="section" id="exclude-list">
<h3>Exclude List<a class="headerlink" href="#exclude-list" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> requires access to an exclude list file. It must either be
installed along with <code class="docutils literal notranslate"><span class="pre">nextcloudcmd</span></code> and thus be available in a system location,
be placed next to the binary as <code class="docutils literal notranslate"><span class="pre">sync-exclude.lst</span></code> or be explicitly specified
with the <code class="docutils literal notranslate"><span class="pre">--exclude</span></code> switch.</p>
</div>
</div>
<div class="section" id="low-disk-space">
<h2>Low Disk Space<a class="headerlink" href="#low-disk-space" title="Permalink to this headline">¶</a></h2>
<p id="index-5">When disk space is low the Nextcloud Client will be unable to synchronize all files. This section describes its behavior in a low disk space situation as well as the options that influence it.</p>
<ol class="arabic simple">
<li>Synchronization of a folder aborts entirely if the remaining disk space falls below 50 MB. This threshold can be adjusted with the <code class="docutils literal notranslate"><span class="pre">OWNCLOUD_CRITICAL_FREE_SPACE_BYTES</span></code> environment variable.</li>
<li>Downloads that would reduce the free disk space below 250 MB will be skipped or aborted. The download will be retried regularly and other synchronization is unaffected. This threshold can be adjusted with the <code class="docutils literal notranslate"><span class="pre">OWNCLOUD_FREE_SPACE_BYTES</span></code> environment variable.</li>
</ol>
</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="#">Advanced Usage</a><ul>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#configuration-file">Configuration File</a></li>
<li><a class="reference internal" href="#environment-variables">Environment Variables</a></li>
<li><a class="reference internal" href="#nextcloud-command-line-client">Nextcloud Command Line Client</a><ul>
<li><a class="reference internal" href="#credential-handling">Credential Handling</a></li>
<li><a class="reference internal" href="#exclude-list">Exclude List</a></li>
</ul>
</li>
<li><a class="reference internal" href="#low-disk-space">Low Disk Space</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="conflicts.html"
title="previous chapter">Conflicts</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="autoupdate.html"
title="next chapter">The Automatic Updater</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/advancedusage.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="autoupdate.html" title="The Automatic Updater"
>next</a> |</li>
<li class="right" >
<a href="conflicts.html" title="Conflicts"
>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>