← Back
Editing: macosvfs.html
<!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>macOS Virtual Files client — Nextcloud 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" /> <link rel="canonical" href="https://docs.nextcloud.com/server/stable/user_manual/desktop/macosvfs.html" /> <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="The Automatic Updater" href="autoupdate.html" /> <link rel="prev" title="Using the Synchronization Client" href="usage.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">Nextcloud latest user manual introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="../webinterface.html">The Nextcloud Web interface</a></li> <li class="toctree-l1"><a class="reference internal" href="../files/index.html">Files & 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 current"><a class="current reference internal" href="#">macOS Virtual Files client</a><ul> <li class="toctree-l3"><a class="reference internal" href="#supported-features">Supported features</a></li> <li class="toctree-l3"><a class="reference internal" href="#installation-and-initial-setup">Installation and initial setup</a></li> <li class="toctree-l3"><a class="reference internal" href="#finder-integration">Finder integration</a></li> <li class="toctree-l3"><a class="reference internal" href="#sync-status-indicators">Sync status indicators</a></li> <li class="toctree-l3"><a class="reference internal" href="#context-menu-actions">Context menu actions</a></li> <li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="autoupdate.html">The Automatic Updater</a></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">Nextcloud 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">macOS Virtual Files client</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/nextcloud/documentation/edit/master/user_manual/desktop/macosvfs.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="macos-virtual-files-client"> <h1>macOS Virtual Files client<a class="headerlink" href="#macos-virtual-files-client" title="Link to this heading"></a></h1> <p>Virtual file-based synchronisation for Nextcloud desktop users is now available on macOS.</p> <p>Unlike on Windows, virtual files support on macOS is provided by a separate client version. This allows us to maintain the best possible experience for classically-synced files, including sync status integration and context menu actions, for users who want to keep using this sync method. Just like our classic sync client, the macOS virtual files client is released alongside the desktop client for Windows and Linux, and will benefit from regular bug-fix and feature updates that improve the user experience.</p> <section id="supported-features"> <h2>Supported features<a class="headerlink" href="#supported-features" title="Link to this heading"></a></h2> <ul class="simple"> <li><p>Per-file local retention and eviction</p></li> <li><p>Intelligent local copy eviction</p></li> <li><p>Integration with Spotlight</p></li> <li><p>File previews within Finder for virtual files</p></li> <li><p>Support for Apple-specific formats such as app bundles and iWork (Pages, Numbers, Keynote) bundles</p></li> <li><p>Remote file locking compatibility</p></li> <li><p>“Edit locally” support</p></li> <li><p>File sharing with other users</p></li> <li><p>Automatic synchronisation of remote changes</p></li> <li><p>More!</p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>To improve remote change detection, we recommend enabling the <code class="docutils literal notranslate"><span class="pre">notify_push</span></code> app on your Nextcloud server. This app will notify the desktop client of changes on the server as soon as they happen, reducing the time it takes for the client to detect changes. This will also eliminate the need for the desktop client to continuously poll the server for changes.</p> </div> </section> <section id="installation-and-initial-setup"> <h2>Installation and initial setup<a class="headerlink" href="#installation-and-initial-setup" title="Link to this heading"></a></h2> <p>The virtual files client is distributed as an installer package that resembles the macOS classic sync client. The desktop client can be installed by following the steps presented by the installer.</p> <p>The virtual files desktop client is interchangeable with the classic sync desktop client. This means your existing accounts and settings will carry over to this client and vice-versa, should you ever decide to go back to the classic sync client. This includes any pre-existing standard sync folders, as the virtual files client also supports classic sync.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Due to technical limitations in macOS we are unable to provide integration in Finder for both classic sync folders and virtual file sync folders. Classic sync folders in the virtual files client will therefore not have Finder integrations such as sync state icons or context menu actions.</p> </div> <p>Any existing or newly-configured accounts will have virtual files automatically enabled. On macOS, each account’s virtual files live under their own domain, separate from any pre-existing classic sync folders. These domains can be found listed under the “Locations” group in the Finder sidebar.</p> <img alt="Finder sidebar showing virtual files domains" src="../_images/macosvfs-finder-sidebar.png" /> <p>Upon first accessing one of these domains, the desktop client will being to request information on remote files from the server. This first synchronisation may take some time depending on the quantity of files hosted on the server.</p> </section> <section id="finder-integration"> <h2>Finder integration<a class="headerlink" href="#finder-integration" title="Link to this heading"></a></h2> <p>The virtual files client has distinct Finder integrations that allow it to more deeply and more natively integrate with the macOS file browser than the classic sync client.</p> </section> <section id="sync-status-indicators"> <h2>Sync status indicators<a class="headerlink" href="#sync-status-indicators" title="Link to this heading"></a></h2> <p>Similarly to classic sync client, the virtual files client displays icons next to virtual files that indicate what their status is.</p> <img alt="Sync status icons for macOS virtual files" src="../_images/macosvfs-sync-status-icons.png" /> <ul class="simple"> <li><p><em>Cloud with arrow</em>: item or its children is virtual and is available for local keeping</p></li> <li><p><em>Cloud outline</em>: item is partially available locally</p></li> <li><p><em>No icon</em>: item is available offline</p></li> </ul> </section> <section id="context-menu-actions"> <h2>Context menu actions<a class="headerlink" href="#context-menu-actions" title="Link to this heading"></a></h2> <p>Control-clicking, two-finger clicking, or right-clicking on a Finder item will provide the context menu, in which you may find several entries provided by the virtual files client that allow you to use some of the features supported by Nextcloud. These include:</p> <ul class="simple"> <li><p>File locking (if supported by server)</p></li> </ul> <img alt="File locking UI for macOS virtual files" src="../_images/macosvfs-file-locking.png" /> <ul class="simple"> <li><p>File sharing (if supported by server)</p></li> </ul> <img alt="File sharing UI for macOS virtual files" src="../_images/macosvfs-file-sharing.png" /> </section> <section id="configuration"> <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h2> <p>Virtual files-related settings can be adjusted on a per-account basis via the Nextcloud desktop client’s settings window.</p> <img alt="macOS virtual files settings" src="../_images/macosvfs-settings.png" /> <p>The virtual files section offers a number of options relevant to virtual files interaction:</p> <ul class="simple"> <li><p>Enable/disable virtual files for the target account</p></li> <li><p>Enable/disable fast sync</p></li> <li><p>Manage local storage usage and evict local copies</p></li> <li><p>Force the virtual files domain to check for updates</p></li> </ul> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="usage.html" class="btn btn-neutral float-left" title="Using the Synchronization Client" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="autoupdate.html" class="btn btn-neutral float-right" title="The Automatic Updater" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2016-2026 Nextcloud GmbH and Nextcloud 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> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ar/" > Arabic </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/br/" > Breton </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ca/" > Catalan </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/zh_CN/" > Chinese </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/zh_HK/" > Chinese (HK) </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/zh_TW/" > Chinese (TW) </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/cs/" > Czech </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/da/" > Danish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/nl/" > Dutch </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/en/" style="color: var(--dark-link-color);" > English </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/fi_FI/" > Finnish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/fr/" > French </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/gl/" > Galician </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/de/" > German </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/el/" > Greek </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/hu_HU/" > Hungarian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/id/" > Indonesian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ga/" > Irish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/it/" > Italian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ja_JP/" > Japanese </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ko/" > Korean </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/mn/" > Mongolian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/nb_NO/" > Norwegian (NB) </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/nn/" > Norwegian (NN) </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/pl/" > Polish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/pt_PT/" > Portuguese </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/pt_BR/" > Portuguese (BR) </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ro/" > Romanian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ru/" > Russian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/si/" > Sinhala </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/sk_SK/" > Slovakian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/sr/" > Slovenian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/es/" > Spanish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/sv/" > Swedish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/ta/" > Tamil </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/tr/" > Turkish </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/uk_UA/" > Ukrainian </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/uz/" > Uzbek </a> </dd> <dd style="width: 32%; vertical-align: top;"> <a href="/server/latest/user_manual/vi/" > Vietnamese </a> </dd> </dl> </div> <div class="rst-other-versions"> <dl> <dt>☁️ Versions</dt> <dd style="width: 32%"> <a href="https://docs.nextcloud.com/server/latest/user_manual" style="color: var(--dark-link-color);" > latest </a> </dd> <dd style="width: 32%"> <a href="https://docs.nextcloud.com/server/stable/user_manual" > stable </a> </dd> <dd style="width: 32%"> <a href="https://docs.nextcloud.com/server/32/user_manual" > 32 </a> </dd> <dd style="width: 32%"> <a href="https://docs.nextcloud.com/server/31/user_manual" > 31 </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>
Save File
Cancel