f7cloud_client/core/doc/user/desktop/autoupdate.html
root 8b6a0139db f7cloud_client
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-17 22:59:26 +00:00

346 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>The Automatic Updater &mdash; F7cloud latest User Manual latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=8ff6e0db" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/general.css?v=c0a7eb24" />
<link rel="stylesheet" type="text/css" href="../_static/dark_mode_css/dark.css?v=70edf1c7" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=a49d5d77"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<script src="../_static/js/versions.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Update channels" href="updatechannel.html" />
<link rel="prev" title="macOS Virtual Files client" href="macosvfs.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<div class="switch-menus">
<div class="version-switch"></div>
<div class="language-switch"></div>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">F7cloud latest user manual introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../webinterface.html">The F7cloud Web interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../files/index.html">Files &amp; synchronization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../talk/index.html">Talk</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Desktop Clients</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html">Using the Synchronization Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="macosvfs.html">macOS Virtual Files client</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">The Automatic Updater</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic Workflow</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#windows">Windows</a></li>
<li class="toctree-l4"><a class="reference internal" href="#macos">macOS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#linux">Linux</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#preventing-automatic-updates">Preventing Automatic Updates</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#preventing-automatic-updates-in-windows-environments">Preventing Automatic Updates in Windows Environments</a></li>
<li class="toctree-l4"><a class="reference internal" href="#preventing-automatic-updates-in-linux-environments">Preventing Automatic Updates in Linux Environments</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="updatechannel.html">Update channels</a></li>
<li class="toctree-l2"><a class="reference internal" href="conflicts.html">Conflicts</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../userpreferences.html">Setting your preferences</a></li>
<li class="toctree-l1"><a class="reference internal" href="../universal_access.html">Universal access</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user_2fa.html">Using two-factor authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../session_management.html">Manage connected browsers and devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../external_storage/index.html">External Storage</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../contents.html">F7cloud latest User Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Desktop Clients</a></li>
<li class="breadcrumb-item active">The Automatic Updater</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/f7cloud/documentation/edit/master/user_manual/desktop/autoupdate.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="the-automatic-updater">
<h1>The Automatic Updater<a class="headerlink" href="#the-automatic-updater" title="Link to this heading"></a></h1>
<p>The Automatic Updater ensures that you always have the
latest features and bug fixes for your F7cloud synchronization client.</p>
<p>The Automatic Updater updates only on macOS and Windows computers; Linux
users only need to use their normal package managers. However, on Linux systems
the Updater will check for updates and notify you when a new version is
available.</p>
<section id="basic-workflow">
<h2>Basic Workflow<a class="headerlink" href="#basic-workflow" title="Link to this heading"></a></h2>
<p>The following sections describe how to use the Automatic Updater on different
operating systems.</p>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Link to this heading"></a></h3>
<p>The F7cloud client checks for updates and downloads them when available. You
can view the update status under <code class="docutils literal notranslate"><span class="pre">Settings</span> <span class="pre">-&gt;</span> <span class="pre">General</span> <span class="pre">-&gt;</span> <span class="pre">Updates</span></code> in the
F7cloud client.</p>
<p>If an update is available, and has been successfully downloaded, the F7cloud
client starts a silent update prior to its next launch and then restarts
itself. Should the silent update fail, the client offers a manual download.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Administrative privileges are required to perform the update.</p>
</div>
</section>
<section id="macos">
<h3>macOS<a class="headerlink" href="#macos" title="Link to this heading"></a></h3>
<p>The macOS client has an autoupdater which uses the Sparkle framework.
This autoupdater is bundled into the client App Bundle and checks for updates
on launch, notifying you if an update is available. This will present a pop-up
that can let you automatically download and install the latest client update
with one click.</p>
<p>In versions of the client where the Sparkle-based autoupdater is not bundled,
a clickable notification will appear informing of an update being available.
Upon clicking on said notification, the download page for the latest version
of the client will be opened in the systems web browser.</p>
<p>Like on other systems, you can view the update status under
<code class="docutils literal notranslate"><span class="pre">Settings</span> <span class="pre">-&gt;</span> <span class="pre">General</span> <span class="pre">-&gt;</span> <span class="pre">Updates</span></code> in the F7cloud client.</p>
</section>
<section id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Link to this heading"></a></h3>
<p>Linux distributions provide their own update tools, so F7cloud clients that use
the Linux operating system do not perform any updates on their own. The client
will inform you (<code class="docutils literal notranslate"><span class="pre">Settings</span> <span class="pre">-&gt;</span> <span class="pre">General</span> <span class="pre">-&gt;</span> <span class="pre">Updates</span></code>) when an update is
available.</p>
</section>
</section>
<section id="preventing-automatic-updates">
<h2>Preventing Automatic Updates<a class="headerlink" href="#preventing-automatic-updates" title="Link to this heading"></a></h2>
<p>In controlled environments, such as companies or universities, you might not
want to enable the auto-update mechanism, as it interferes with controlled
deployment tools and policies. To address this case, it is possible to disable
the auto-updater entirely. The following sections describe how to disable the
auto-update mechanism for different operating systems.</p>
<section id="preventing-automatic-updates-in-windows-environments">
<h3>Preventing Automatic Updates in Windows Environments<a class="headerlink" href="#preventing-automatic-updates-in-windows-environments" title="Link to this heading"></a></h3>
<p>Users may disable automatic updates by adding this line to the [General]
section of their <code class="docutils literal notranslate"><span class="pre">f7cloud.cfg</span></code> files:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">skipUpdateCheck</span><span class="o">=</span><span class="n">true</span>
</pre></div>
</div>
<p>Windows administrators have more options for preventing automatic updates in
Windows environments by using one of two methods. The first method allows users
to override the automatic update check mechanism, whereas the second method
prevents any manual overrides.</p>
<p>To prevent automatic updates, but allow manual overrides:</p>
<ol class="arabic">
<li><p>Edit these Registry keys:</p>
<blockquote>
<div><ol class="loweralpha simple">
<li><p>(32-bit-Windows) <code class="docutils literal notranslate"><span class="pre">HKEY_LOCAL_MACHINE\Software\F7cloud\F7cloud</span></code></p></li>
<li><p>(64-bit-Windows) <code class="docutils literal notranslate"><span class="pre">HKEY_LOCAL_MACHINE\Software\Wow6432Node\F7cloud\F7cloud</span></code></p></li>
</ol>
</div></blockquote>
</li>
<li><p>Add the key <code class="docutils literal notranslate"><span class="pre">skipUpdateCheck</span></code> (of type DWORD).</p></li>
<li><p>Specify a value of <code class="docutils literal notranslate"><span class="pre">1</span></code> to the machine.</p></li>
</ol>
<p>To manually override this key, use the same value in <code class="docutils literal notranslate"><span class="pre">HKEY_CURRENT_USER</span></code>.</p>
<p>To prevent automatic updates and disallow manual overrides:</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is the preferred method of controlling the updater behavior using
Group Policies.</p>
</div>
<ol class="arabic">
<li><p>Edit this Registry key:</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">HKEY_LOCAL_MACHINE\Software\Policies\F7cloud</span> <span class="pre">GmbH\F7cloud</span></code></p>
</div></blockquote>
</li>
<li><p>Add the key <code class="docutils literal notranslate"><span class="pre">skipUpdateCheck</span></code> (of type DWORD).</p></li>
<li><p>Specify a value of <code class="docutils literal notranslate"><span class="pre">1</span></code> to the machine.</p></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>branded clients have different key names</p>
</div>
</section>
<section id="preventing-automatic-updates-in-linux-environments">
<h3>Preventing Automatic Updates in Linux Environments<a class="headerlink" href="#preventing-automatic-updates-in-linux-environments" title="Link to this heading"></a></h3>
<p>Because the Linux client does not provide automatic updating functionality, there is no
need to remove the automatic-update check. However, if you want to disable it edit your desktop
client configuration file, <code class="docutils literal notranslate"><span class="pre">$HOME/.config/F7cloud/f7cloud.cfg</span></code>.
Add this line to the [General] section:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">skipUpdateCheck</span><span class="o">=</span><span class="n">true</span>
</pre></div>
</div>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="macosvfs.html" class="btn btn-neutral float-left" title="macOS Virtual Files client" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="updatechannel.html" class="btn btn-neutral float-right" title="Update channels" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2016-2026 F7cloud GmbH and F7cloud contributors.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<!-- Here go the languages -->
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
🌐
English
<span class="fa fa-caret-down"></span>
 ☁️ latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>🌐 Languages</dt>
</dl>
</div>
<div class="rst-other-versions">
<dl>
<dt>☁️ Versions</dt>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/latest/user_manual"
style="color: var(--dark-link-color);"
>
latest
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/stable/user_manual"
>
stable
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/31/user_manual"
>
31
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/30/user_manual"
>
30
</a>
</dd>
<dd style="width: 32%">
<a href="https://docs.f7cloud.com/server/29/user_manual"
>
29
</a>
</dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>