diff --git a/_shared_assets/static/custom.css b/_shared_assets/static/custom.css index e5f57c06c27..dfae7e564b4 100644 --- a/_shared_assets/static/custom.css +++ b/_shared_assets/static/custom.css @@ -164,6 +164,23 @@ html[data-theme="dark"] .rst-content img { box-shadow: 0 2px 8px rgba(255, 255, 255, 0.15); } +/* Desktop synchronization status icons are UI glyphs, not screenshots. */ +.rst-content img.desktop-status-icon, +html[data-theme="dark"] .rst-content img.desktop-status-icon { + border-radius: 0; + box-shadow: none; +} + +.rst-content table.desktop-status-icons th, +.rst-content table.desktop-status-icons td { + vertical-align: middle; +} + +.rst-content table.desktop-status-icons th:not(:first-child), +.rst-content table.desktop-status-icons td:not(:first-child) { + text-align: center; +} + /* ICONS LIST */ div#list-of-available-icons > blockquote { margin: 0; diff --git a/user_manual/desktop/client_features.rst b/user_manual/desktop/client_features.rst new file mode 100644 index 00000000000..76b26f9a12c --- /dev/null +++ b/user_manual/desktop/client_features.rst @@ -0,0 +1,48 @@ +=============== +Client features +=============== + +Activities +---------- + +Open **Activities** in the client to see recent file activity and synchronization warnings. If files conflict, use +**Resolve conflicts** to review them. + +.. image:: images/activities.png + :alt: Activities view with recent file changes, a sync warning, and a conflict + :width: 50% + :align: center + +User status +----------- + +If your server has the user status app, open your account in the settings dialog and click **Online status**. Choose +your availability, enter a status message or select a suggested one, and choose when to clear it. Click **Set status +message** to save it, or **Clear status message** to remove an existing message. + +.. image:: images/user-status.png + :alt: User status dialog with availability, status message, and expiration controls + :width: 50% + :align: center + +Search +------ + +Open **Search** in the client and enter a term to find files and other results from your Nextcloud server. Use the +**Type**, **Date**, and **People** filters to narrow the results. + +.. image:: images/search-results.png + :alt: Search results for Project with Type, Date, and People filters + :width: 50% + :align: center + +Assistant +--------- + +If your server provides the Assistant, open **Assistant** in the client to ask a question or continue a conversation. +Select a conversation, type your message, and click **Send**. + +.. image:: images/assistant-chat.png + :alt: Assistant conversation with a question, response, and message field + :width: 50% + :align: center diff --git a/user_manual/desktop/faq.rst b/user_manual/desktop/faq.rst index 4893c7cb643..25f997b4b31 100644 --- a/user_manual/desktop/faq.rst +++ b/user_manual/desktop/faq.rst @@ -92,12 +92,16 @@ Specifically, you have to: .. figure:: images/setup/remove.png :alt: Remove an existing connection + :width: 50% + :align: center To do so, click the "**Account**" drop-down menu and then click "Remove". This will display a "**Confirm Account Removal**" dialog window. .. figure:: images/setup/confirm.png :alt: Remove existing connection confirmation dialog + :width: 50% + :align: center If you're sure, click "**Remove connection**". @@ -105,6 +109,8 @@ Then, click the Account drop-down menu again, and this time click "**Add new**". .. figure:: images/setup/wizard.png :alt: Replacement connection wizard + :width: 50% + :align: center This opens the Nextcloud Connection Wizard *but* with an extra option. This option provides the ability to either: keep the existing data (synced by the previous connection) or to start a clean sync (erasing the existing data). diff --git a/user_manual/desktop/images/activities.png b/user_manual/desktop/images/activities.png new file mode 100644 index 00000000000..978dd18aced Binary files /dev/null and b/user_manual/desktop/images/activities.png differ diff --git a/user_manual/desktop/images/assistant-chat.png b/user_manual/desktop/images/assistant-chat.png new file mode 100644 index 00000000000..307da414f0f Binary files /dev/null and b/user_manual/desktop/images/assistant-chat.png differ diff --git a/user_manual/desktop/images/general_settings_folder_context_menu.png b/user_manual/desktop/images/general_settings_folder_context_menu.png deleted file mode 100644 index 46e17f71a6b..00000000000 Binary files a/user_manual/desktop/images/general_settings_folder_context_menu.png and /dev/null differ diff --git a/user_manual/desktop/images/icon-error.png b/user_manual/desktop/images/icon-error.png deleted file mode 100644 index 6260bba2aa5..00000000000 Binary files a/user_manual/desktop/images/icon-error.png and /dev/null differ diff --git a/user_manual/desktop/images/icon-information.png b/user_manual/desktop/images/icon-information.png deleted file mode 100644 index 01e57e75de4..00000000000 Binary files a/user_manual/desktop/images/icon-information.png and /dev/null differ diff --git a/user_manual/desktop/images/icon-offline.png b/user_manual/desktop/images/icon-offline.png deleted file mode 100644 index ab80cb1b6ef..00000000000 Binary files a/user_manual/desktop/images/icon-offline.png and /dev/null differ diff --git a/user_manual/desktop/images/icon-paused.png b/user_manual/desktop/images/icon-paused.png deleted file mode 100644 index c077666d545..00000000000 Binary files a/user_manual/desktop/images/icon-paused.png and /dev/null differ diff --git a/user_manual/desktop/images/icon-status-error.png b/user_manual/desktop/images/icon-status-error.png new file mode 100644 index 00000000000..19d062d24c3 Binary files /dev/null and b/user_manual/desktop/images/icon-status-error.png differ diff --git a/user_manual/desktop/images/icon-status-offline.png b/user_manual/desktop/images/icon-status-offline.png new file mode 100644 index 00000000000..0159894e5e7 Binary files /dev/null and b/user_manual/desktop/images/icon-status-offline.png differ diff --git a/user_manual/desktop/images/icon-status-ok.png b/user_manual/desktop/images/icon-status-ok.png new file mode 100644 index 00000000000..043f2dc8388 Binary files /dev/null and b/user_manual/desktop/images/icon-status-ok.png differ diff --git a/user_manual/desktop/images/icon-status-pause.png b/user_manual/desktop/images/icon-status-pause.png new file mode 100644 index 00000000000..0c50902e6ff Binary files /dev/null and b/user_manual/desktop/images/icon-status-pause.png differ diff --git a/user_manual/desktop/images/icon-status-sync.png b/user_manual/desktop/images/icon-status-sync.png new file mode 100644 index 00000000000..128750ec1d0 Binary files /dev/null and b/user_manual/desktop/images/icon-status-sync.png differ diff --git a/user_manual/desktop/images/icon-status-warning.png b/user_manual/desktop/images/icon-status-warning.png new file mode 100644 index 00000000000..bf66dec02d9 Binary files /dev/null and b/user_manual/desktop/images/icon-status-warning.png differ diff --git a/user_manual/desktop/images/icon-syncing.png b/user_manual/desktop/images/icon-syncing.png deleted file mode 100644 index 85abef780d3..00000000000 Binary files a/user_manual/desktop/images/icon-syncing.png and /dev/null differ diff --git a/user_manual/desktop/images/icon-tray-colored-error.png b/user_manual/desktop/images/icon-tray-colored-error.png new file mode 100644 index 00000000000..d194e883f66 Binary files /dev/null and b/user_manual/desktop/images/icon-tray-colored-error.png differ diff --git a/user_manual/desktop/images/icon-tray-colored-offline.png b/user_manual/desktop/images/icon-tray-colored-offline.png new file mode 100644 index 00000000000..d010a4bca1c Binary files /dev/null and b/user_manual/desktop/images/icon-tray-colored-offline.png differ diff --git a/user_manual/desktop/images/icon-tray-colored-ok.png b/user_manual/desktop/images/icon-tray-colored-ok.png new file mode 100644 index 00000000000..13119b7634f Binary files /dev/null and b/user_manual/desktop/images/icon-tray-colored-ok.png differ diff --git a/user_manual/desktop/images/icon-tray-colored-pause.png b/user_manual/desktop/images/icon-tray-colored-pause.png new file mode 100644 index 00000000000..90458372b14 Binary files /dev/null and b/user_manual/desktop/images/icon-tray-colored-pause.png differ diff --git a/user_manual/desktop/images/icon-tray-colored-sync.png b/user_manual/desktop/images/icon-tray-colored-sync.png new file mode 100644 index 00000000000..4c6421d016d Binary files /dev/null and b/user_manual/desktop/images/icon-tray-colored-sync.png differ diff --git a/user_manual/desktop/images/icon-tray-colored-warning.png b/user_manual/desktop/images/icon-tray-colored-warning.png new file mode 100644 index 00000000000..87eb4174c9d Binary files /dev/null and b/user_manual/desktop/images/icon-tray-colored-warning.png differ diff --git a/user_manual/desktop/images/icon-tray-error.png b/user_manual/desktop/images/icon-tray-error.png new file mode 100644 index 00000000000..24ae38b38c7 Binary files /dev/null and b/user_manual/desktop/images/icon-tray-error.png differ diff --git a/user_manual/desktop/images/icon-tray-offline.png b/user_manual/desktop/images/icon-tray-offline.png new file mode 100644 index 00000000000..0b4b2f8181d Binary files /dev/null and b/user_manual/desktop/images/icon-tray-offline.png differ diff --git a/user_manual/desktop/images/icon-tray-ok.png b/user_manual/desktop/images/icon-tray-ok.png new file mode 100644 index 00000000000..3004a9c7321 Binary files /dev/null and b/user_manual/desktop/images/icon-tray-ok.png differ diff --git a/user_manual/desktop/images/icon-tray-pause.png b/user_manual/desktop/images/icon-tray-pause.png new file mode 100644 index 00000000000..9211929718e Binary files /dev/null and b/user_manual/desktop/images/icon-tray-pause.png differ diff --git a/user_manual/desktop/images/icon-tray-sync.png b/user_manual/desktop/images/icon-tray-sync.png new file mode 100644 index 00000000000..f41f3812c6a Binary files /dev/null and b/user_manual/desktop/images/icon-tray-sync.png differ diff --git a/user_manual/desktop/images/icon-tray-warning.png b/user_manual/desktop/images/icon-tray-warning.png new file mode 100644 index 00000000000..34477754fb8 Binary files /dev/null and b/user_manual/desktop/images/icon-tray-warning.png differ diff --git a/user_manual/desktop/images/icon.png b/user_manual/desktop/images/icon.png deleted file mode 100644 index d8f6830d493..00000000000 Binary files a/user_manual/desktop/images/icon.png and /dev/null differ diff --git a/user_manual/desktop/images/ignored_files_editor.png b/user_manual/desktop/images/ignored_files_editor.png deleted file mode 100644 index ba9a8de71aa..00000000000 Binary files a/user_manual/desktop/images/ignored_files_editor.png and /dev/null differ diff --git a/user_manual/desktop/images/main_dialog.png b/user_manual/desktop/images/main_dialog.png deleted file mode 100644 index e00a967d805..00000000000 Binary files a/user_manual/desktop/images/main_dialog.png and /dev/null differ diff --git a/user_manual/desktop/images/search-results.png b/user_manual/desktop/images/search-results.png new file mode 100644 index 00000000000..c22482dfdcd Binary files /dev/null and b/user_manual/desktop/images/search-results.png differ diff --git a/user_manual/desktop/images/settings-account-classic.png b/user_manual/desktop/images/settings-account-classic.png new file mode 100644 index 00000000000..eb7d14114ab Binary files /dev/null and b/user_manual/desktop/images/settings-account-classic.png differ diff --git a/user_manual/desktop/images/settings-advanced.png b/user_manual/desktop/images/settings-advanced.png new file mode 100644 index 00000000000..8236fbcbffe Binary files /dev/null and b/user_manual/desktop/images/settings-advanced.png differ diff --git a/user_manual/desktop/images/settings-general.png b/user_manual/desktop/images/settings-general.png new file mode 100644 index 00000000000..fff8c626957 Binary files /dev/null and b/user_manual/desktop/images/settings-general.png differ diff --git a/user_manual/desktop/images/settings-ignored-files.png b/user_manual/desktop/images/settings-ignored-files.png new file mode 100644 index 00000000000..27aac087b6f Binary files /dev/null and b/user_manual/desktop/images/settings-ignored-files.png differ diff --git a/user_manual/desktop/images/settings-info.png b/user_manual/desktop/images/settings-info.png new file mode 100644 index 00000000000..c7ec9db9906 Binary files /dev/null and b/user_manual/desktop/images/settings-info.png differ diff --git a/user_manual/desktop/images/settings_general.png b/user_manual/desktop/images/settings_general.png deleted file mode 100644 index be2d10dd1ca..00000000000 Binary files a/user_manual/desktop/images/settings_general.png and /dev/null differ diff --git a/user_manual/desktop/images/settings_network.png b/user_manual/desktop/images/settings_network.png deleted file mode 100644 index d9da49c105b..00000000000 Binary files a/user_manual/desktop/images/settings_network.png and /dev/null differ diff --git a/user_manual/desktop/images/settingsdialog.png b/user_manual/desktop/images/settingsdialog.png deleted file mode 100644 index 650e8e4c2fb..00000000000 Binary files a/user_manual/desktop/images/settingsdialog.png and /dev/null differ diff --git a/user_manual/desktop/images/share_context_menu.png b/user_manual/desktop/images/share_context_menu.png deleted file mode 100644 index 3dcefb6c21c..00000000000 Binary files a/user_manual/desktop/images/share_context_menu.png and /dev/null differ diff --git a/user_manual/desktop/images/share_dialog.png b/user_manual/desktop/images/share_dialog.png deleted file mode 100644 index 229da6ca943..00000000000 Binary files a/user_manual/desktop/images/share_dialog.png and /dev/null differ diff --git a/user_manual/desktop/images/sharing-advanced-settings.png b/user_manual/desktop/images/sharing-advanced-settings.png new file mode 100644 index 00000000000..51dc992a12b Binary files /dev/null and b/user_manual/desktop/images/sharing-advanced-settings.png differ diff --git a/user_manual/desktop/images/sharing-details.png b/user_manual/desktop/images/sharing-details.png new file mode 100644 index 00000000000..da75c560173 Binary files /dev/null and b/user_manual/desktop/images/sharing-details.png differ diff --git a/user_manual/desktop/images/sharing-overview.png b/user_manual/desktop/images/sharing-overview.png new file mode 100644 index 00000000000..88adf11e615 Binary files /dev/null and b/user_manual/desktop/images/sharing-overview.png differ diff --git a/user_manual/desktop/images/traymenu.png b/user_manual/desktop/images/traymenu.png deleted file mode 100644 index ccbea82f2a3..00000000000 Binary files a/user_manual/desktop/images/traymenu.png and /dev/null differ diff --git a/user_manual/desktop/images/user-status.png b/user_manual/desktop/images/user-status.png new file mode 100644 index 00000000000..dce8b5976ce Binary files /dev/null and b/user_manual/desktop/images/user-status.png differ diff --git a/user_manual/desktop/images/user_status-selector_dialog.png b/user_manual/desktop/images/user_status-selector_dialog.png deleted file mode 100644 index 6f82cfcf1cd..00000000000 Binary files a/user_manual/desktop/images/user_status-selector_dialog.png and /dev/null differ diff --git a/user_manual/desktop/images/user_status_selector_main_dialog.png b/user_manual/desktop/images/user_status_selector_main_dialog.png deleted file mode 100644 index 4c38f89f54f..00000000000 Binary files a/user_manual/desktop/images/user_status_selector_main_dialog.png and /dev/null differ diff --git a/user_manual/desktop/images/wizard-advanced-options.png b/user_manual/desktop/images/wizard-advanced-options.png new file mode 100644 index 00000000000..59f80f1e36a Binary files /dev/null and b/user_manual/desktop/images/wizard-advanced-options.png differ diff --git a/user_manual/desktop/images/wizard-browser-auth.png b/user_manual/desktop/images/wizard-browser-auth.png new file mode 100644 index 00000000000..690b773dd5b Binary files /dev/null and b/user_manual/desktop/images/wizard-browser-auth.png differ diff --git a/user_manual/desktop/images/wizard-client-certificate.png b/user_manual/desktop/images/wizard-client-certificate.png new file mode 100644 index 00000000000..57963537bb3 Binary files /dev/null and b/user_manual/desktop/images/wizard-client-certificate.png differ diff --git a/user_manual/desktop/images/wizard-proxy-settings.png b/user_manual/desktop/images/wizard-proxy-settings.png new file mode 100644 index 00000000000..df96199d7f4 Binary files /dev/null and b/user_manual/desktop/images/wizard-proxy-settings.png differ diff --git a/user_manual/desktop/images/wizard-secure-connection.png b/user_manual/desktop/images/wizard-secure-connection.png new file mode 100644 index 00000000000..24173c44512 Binary files /dev/null and b/user_manual/desktop/images/wizard-secure-connection.png differ diff --git a/user_manual/desktop/images/wizard-server.png b/user_manual/desktop/images/wizard-server.png new file mode 100644 index 00000000000..654053ad387 Binary files /dev/null and b/user_manual/desktop/images/wizard-server.png differ diff --git a/user_manual/desktop/images/wizard-sync-classic.png b/user_manual/desktop/images/wizard-sync-classic.png new file mode 100644 index 00000000000..3be9082eb09 Binary files /dev/null and b/user_manual/desktop/images/wizard-sync-classic.png differ diff --git a/user_manual/desktop/images/wizard-sync-file-provider.png b/user_manual/desktop/images/wizard-sync-file-provider.png new file mode 100644 index 00000000000..ba0eac1dfce Binary files /dev/null and b/user_manual/desktop/images/wizard-sync-file-provider.png differ diff --git a/user_manual/desktop/images/wizard_advanced.png b/user_manual/desktop/images/wizard_advanced.png deleted file mode 100644 index ee71bd04ce0..00000000000 Binary files a/user_manual/desktop/images/wizard_advanced.png and /dev/null differ diff --git a/user_manual/desktop/images/wizard_flow2.png b/user_manual/desktop/images/wizard_flow2.png deleted file mode 100644 index e67afce7db3..00000000000 Binary files a/user_manual/desktop/images/wizard_flow2.png and /dev/null differ diff --git a/user_manual/desktop/images/wizard_setup.png b/user_manual/desktop/images/wizard_setup.png deleted file mode 100644 index 99247ecf832..00000000000 Binary files a/user_manual/desktop/images/wizard_setup.png and /dev/null differ diff --git a/user_manual/desktop/images/wizard_welcome.png b/user_manual/desktop/images/wizard_welcome.png deleted file mode 100644 index 35bbb501a6d..00000000000 Binary files a/user_manual/desktop/images/wizard_welcome.png and /dev/null differ diff --git a/user_manual/desktop/index.rst b/user_manual/desktop/index.rst index cd80a78defa..70e2c982876 100644 --- a/user_manual/desktop/index.rst +++ b/user_manual/desktop/index.rst @@ -9,16 +9,17 @@ synchronized between your computer and your Nextcloud server. :maxdepth: 1 installation - uninstallation usage macosfileprovider commandline + client_features options configfile envvars autoupdate updatechannel conflicts + uninstallation faq For additional information, see: diff --git a/user_manual/desktop/installation.rst b/user_manual/desktop/installation.rst index d60044756d7..170563137b4 100644 --- a/user_manual/desktop/installation.rst +++ b/user_manual/desktop/installation.rst @@ -65,61 +65,18 @@ distribution's documentation. Linux users must also have a password manager enabled, such as GNOME Keyring or KWallet, so that the desktop client can log in automatically. -Initial Setup +Initial setup ------------- -After installation, the initial setup wizard is triggered. In the setup wizard, -you can log in to your server, create an account with a provider, and configure -which folders to sync. The wizard will guide you step-by-step through the -essential configuration options and basic account setup. +After installation, the setup wizard opens. Enter the address you use to access your Nextcloud server in a browser, +then click **Log in**. -First, you need to enter the URL of your Nextcloud server. +.. image:: images/wizard-server.png + :alt: Server address field and Log in button in the desktop client setup wizard + :width: 50% + :align: center -.. image:: images/wizard_welcome.png - :alt: form for choosing between login and registering - -If you already have an account on a Nextcloud instance, click ``Login to your -Nextcloud``. If you do not yet have a Nextcloud instance or an account, you may -need to create one first. Alternatively, you might want to register an account -with a provider. Press ``Create account with Provider`` in that case. - -.. note:: - The desktop client build you are using may have been built without provider - support. In that case, you won't see this page and will immediately see the - next page. - -.. image:: images/wizard_setup.png - :alt: form for entering Nextcloud server URL - -Enter the URL for your Nextcloud instance. The URL is the same URL that -you type into your browser when you try to access your Nextcloud -instance. - -.. image:: images/wizard_flow2.png - :alt: form waiting for authorization - -Now your web browser should open and prompt you to log in to your -Nextcloud instance. Enter your username and password in your web -browser and click *Grant access* when prompted. After you do that, -go back to the wizard. - -.. note:: - You might not need to enter your username and password if you are - already logged in to your web browser. - -.. image:: images/wizard_advanced.png - :alt: Select which remote folders to sync, and which local folder to store - them in. - -On the local folder options screen, you may sync all of your files on -the Nextcloud server, or select individual folders. The default local -sync folder is ``Nextcloud``, in your home directory. You may change -this as well. - -When you have completed selecting your sync folders, click the *Connect* button. The client will attempt to connect to your -Nextcloud server. If it is successful, the wizard will close itself. You -can then observe the sync activity and open the main dialog by clicking -on the tray icon. +For the remaining wizard steps, including browser authorization and sync options, see :ref:`desktop-add-account`. .. Links diff --git a/user_manual/desktop/macosfileprovider.rst b/user_manual/desktop/macosfileprovider.rst index 041ad3da4d9..326c77757ab 100644 --- a/user_manual/desktop/macosfileprovider.rst +++ b/user_manual/desktop/macosfileprovider.rst @@ -28,6 +28,8 @@ per-account basis via the Nextcloud desktop client's settings window. .. image:: images/macosfileprovider-settings.jpg :alt: Nextcloud desktop client settings showing the macOS File Provider extension toggle + :width: 50% + :align: center Here the integration into Finder can be enabled or disabled. @@ -44,6 +46,8 @@ content on disk is defined by macOS. .. image:: images/macosfileprovider-finder-sidebar.jpg :alt: Finder sidebar showing a Nextcloud File Provider domain + :width: 50% + :align: center .. note:: To accelerate server-side change detection, we recommend enabling the @@ -78,6 +82,8 @@ Context menu actions .. image:: images/macosfileprovider-context-menu.jpg :alt: macOS Finder context menu on a Nextcloud file showing Keep Downloaded, Lock, and Share options + :width: 50% + :align: center The File Provider extension also provides special Nextcloud features through the context menu in Finder. @@ -104,6 +110,8 @@ Locking .. image:: images/macosfileprovider-file-locking.jpg :alt: macOS Finder showing a Nextcloud file with a lock indicator after locking + :width: 50% + :align: center If the server supports file locking, the client will offer manual locking and unlocking of files in Finder. @@ -113,6 +121,8 @@ Sharing .. image:: images/macosfileprovider-file-sharing.jpg :alt: macOS Finder share management panel for a Nextcloud file showing existing shares + :width: 50% + :align: center When the server supports sharing and the item is allowed to be shared, then you can create new shares or manage existing shares for an item directly diff --git a/user_manual/desktop/usage.rst b/user_manual/desktop/usage.rst index 9b5a21d4bb6..591f9fb0712 100644 --- a/user_manual/desktop/usage.rst +++ b/user_manual/desktop/usage.rst @@ -1,281 +1,264 @@ -================================ -Using the Synchronization Client -================================ +================ +Using the Client +================ -The Nextcloud Desktop Client remains in the background and is visible as an icon -in the system tray (Windows, KDE), menu bar (macOS), or notification area -(Linux). +The Nextcloud desktop client runs in the background. Open its settings from the system tray on Windows and Linux or +the menu bar on macOS. -.. figure:: images/icon.png - :alt: Status icon, green circle and white checkmark +.. _desktop-add-account: -The status indicator uses icons to indicate the current status of your -synchronization. The green circle with the white checkmark tells you that your -synchronization is current and you are connected to your Nextcloud server. +Add account +----------- -.. figure:: images/icon-syncing.png - :alt: Status icon, blue circle and white semi-circles +To connect another Nextcloud account, open the settings dialog and click **Add account** in the sidebar. Enter the +address you use to access your Nextcloud server in a browser, then click **Log in**. -The blue icon with the white semi-circles means synchronization is in progress. +.. image:: images/wizard-server.png + :alt: Setup wizard with the server address field and Log in button + :width: 50% + :align: center -.. figure:: images/icon-paused.png - :alt: Status icon, grey circle and vertical parallel lines +If your network requires a proxy, click **Proxy settings** before logging in. Choose the system proxy or enter your +proxy settings manually, then click **Done**. -The grey icon with the parallel lines tells you your synchronization -has been paused. (Most likely by you.) +.. image:: images/wizard-proxy-settings.png + :alt: Proxy settings dialog with no proxy, system proxy, and manual proxy options + :width: 50% + :align: center -.. figure:: images/icon-offline.png - :alt: Status icon, gray circle and three horizontal white dots +If the secure connection fails, check the server address and contact your server administrator. The wizard may offer +to connect without TLS or use a client certificate. Use **Use client certificate** only if your server requires one. -The gray icon with three white dots means your sync client has lost its -connection with your Nextcloud server. +.. image:: images/wizard-secure-connection.png + :alt: Warning that the secure server connection failed, with client certificate and unencrypted options + :width: 50% + :align: center -.. figure:: images/icon-information.png - :alt: Status icon, sign "!" in yellow circle +If prompted for a client certificate, choose the PKCS#12 file provided by your administrator, enter its password, +and click **Connect**. -When you see a yellow circle with the sign "!" that is the informational icon, -so you should click it to see what it has to tell you. +.. image:: images/wizard-client-certificate.png + :alt: Client certificate dialog with certificate file and password fields + :width: 50% + :align: center -.. figure:: images/icon-error.png - :alt: Status icon, red circle and white x +The wizard asks you to switch to your browser. Click **Open** if the browser does not open automatically. Log in and +grant the desktop client access when prompted. Then return to the wizard. -The red circle with the white "x" indicates a configuration error, such as an -incorrect login or server URL. +.. image:: images/wizard-browser-auth.png + :alt: Setup wizard prompting you to open a browser to authorize the account + :width: 50% + :align: center -Systray Icon ------------- - -A right-click on the systray icon opens a menu for quick access to multiple -operations. - -.. figure:: images/traymenu.png - :alt: the right-click sync client menu +Choose how to sync your files. With classic synchronization, choose **Synchronize everything** or **Choose what to +sync**. Use **Choose** beside **Local sync folder** to change where files are stored, then click **Done**. -This menu provides the following options: +.. image:: images/wizard-sync-classic.png + :alt: Classic synchronization options and local sync folder in the setup wizard + :width: 50% + :align: center -* Open main dialog -* Pause sync/Resume sync -* Settings -* Exit Nextcloud, logging out and closing the client +You can choose **File Provider** to download files on demand. Click **Done** to finish adding the account. On macOS, +see :doc:`macosfileprovider` for details about Finder integration. -A left-click on your systray icon opens the main dialog of the desktop client. +.. image:: images/wizard-sync-file-provider.png + :alt: File Provider selected in the setup wizard + :width: 50% + :align: center -.. figure:: images/main_dialog.png - :alt: Main dialog +Before finishing classic synchronization, click **Advanced** if you want confirmation before syncing large folders +or external storage. Set your preferences in **Advanced options**, then click **Done** to return to the wizard. -The main dialogs show recent activities, errors and server notifications. +.. image:: images/wizard-advanced-options.png + :alt: Advanced options for large folders and external storage in the setup wizard + :width: 50% + :align: center -When clicking on the main dialog and then clicking on the avatar of the user, the Settings can be opened. +Settings dialog +--------------- -Configuring Nextcloud Account Settings --------------------------------------- +Select an account in the sidebar to see its sync status, local folder, storage usage, and connection settings. Use +**Add Folder Sync Connection** to set up another classic sync folder for that account. You can log out or remove the +account from the same page. -.. figure:: images/settingsdialog.png - :alt: Main dialog +.. image:: images/settings-account-classic.png + :alt: Account settings with classic sync status, connection settings, and account controls + :width: 50% + :align: center -At the top of the window are tabs for each configured sync account, and two -others for General and Network settings. On your account tabs you -have the following features: +Under **General**, choose whether to launch the client at startup, use monochrome icons, and show notifications. +On macOS, you can also enable File Provider for all accounts. This setting replaces classic sync folders and their +Finder integration. -* Connection status, showing which Nextcloud server you are connected to, and - your Nextcloud username. -* Used and available space on the server. -* Current synchronization status. -* **Add Folder Sync Connection** button. +.. image:: images/settings-general.png + :alt: General settings for startup, icons, File Provider, and notifications + :width: 50% + :align: center -The little button with three dots (the overflow menu) that sits to the right of -the sync status bar offers additional options: +Under **Advanced**, set confirmation thresholds for large folders and external storage. You can also adjust the +server polling interval, decide whether removed files go to the trash, edit ignored files, or create a debug archive. -* Open Folder -* Choose What to Sync (This appears only when your file tree is collapsed, and - expands the file tree) -* Pause Sync / Resume Sync -* Remove folder sync connection -* Availability (Only available if virtual files support is enabled) -* Enable virtual file support/Disable virtual file support +.. image:: images/settings-advanced.png + :alt: Advanced settings for sync confirmations, server polling, ignored files, and debug archives + :width: 50% + :align: center -**Open Folder** opens your local Nextcloud sync folder. +.. _usingIgnoredFilesEditor-label: -**Pause Sync** pauses sync operations without making any changes to your -account. It will continue to update file and folder lists, without -downloading or updating files. To stop all sync activity use **Remove -Folder Sync Connection**. +To exclude files or folders from synchronization, click **Edit Ignored Files** under **Advanced**. Add a pattern for +each item you want to ignore. An asterisk (``*``) matches any number of characters, a question mark (``?``) +matches one character, and a trailing slash (``/``) limits a pattern to folders. Select **Allow Deletion** only for +ignored items that the client may remove when they prevent a folder from being deleted. Click **OK** to save. -.. figure:: images/general_settings_folder_context_menu.png - :alt: Extra options for sync operations +.. image:: images/settings-ignored-files.png + :alt: Ignored files editor with patterns, Allow Deletion checkboxes, and save controls + :width: 50% + :align: center -.. note:: Nextcloud does not preserve the mtime (modification time) of - directories, though it does update the mtimes on files. See - `Wrong folder date when syncing - `_ for discussion of this. +Under **Info**, you can check the desktop client version and open its usage documentation or legal notice. -Adding New Accounts -------------------- +.. image:: images/settings-info.png + :alt: Info page showing the desktop client version and documentation link + :width: 50% + :align: center -You may configure multiple Nextcloud accounts in your desktop sync client. Simply -click the **Account** > **Add New** button on any account tab to add a new -account, and then follow the account creation wizard. The new account will -appear as a new tab in the settings dialog, where you can adjust its settings at -any time. Use **Account** > **Remove** to delete accounts. +Systray icon +------------ -File Manager Overlay Icons +The desktop client shows a status icon in the system tray on Windows and Linux or the menu bar on macOS. Colorful +status icons and colorful or monochrome tray icons are available for the same sync states. You can choose monochrome +icons under **General** in the settings dialog. + +.. list-table:: Synchronization status icons + :class: desktop-status-icons + :header-rows: 1 + :widths: 46 18 18 18 + + * - State + - Status + - Mono tray + - Color tray + * - Up to date and connected + - .. image:: images/icon-status-ok.png + :alt: Colorful up-to-date status icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-ok.png + :alt: Monochrome up-to-date tray icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-colored-ok.png + :alt: Colorful up-to-date tray icon + :width: 25px + :class: desktop-status-icon + * - Synchronizing + - .. image:: images/icon-status-sync.png + :alt: Colorful synchronizing status icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-sync.png + :alt: Monochrome synchronizing tray icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-colored-sync.png + :alt: Colorful synchronizing tray icon + :width: 25px + :class: desktop-status-icon + * - Paused + - .. image:: images/icon-status-pause.png + :alt: Colorful paused status icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-pause.png + :alt: Monochrome paused tray icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-colored-pause.png + :alt: Colorful paused tray icon + :width: 25px + :class: desktop-status-icon + * - Offline + - .. image:: images/icon-status-offline.png + :alt: Colorful offline status icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-offline.png + :alt: Monochrome offline tray icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-colored-offline.png + :alt: Colorful offline tray icon + :width: 25px + :class: desktop-status-icon + * - Warning; open the client for details + - .. image:: images/icon-status-warning.png + :alt: Colorful warning status icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-warning.png + :alt: Monochrome warning tray icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-colored-warning.png + :alt: Colorful warning tray icon + :width: 25px + :class: desktop-status-icon + * - Error; open the client for details + - .. image:: images/icon-status-error.png + :alt: Colorful error status icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-error.png + :alt: Monochrome error tray icon + :width: 25px + :class: desktop-status-icon + - .. image:: images/icon-tray-colored-error.png + :alt: Colorful error tray icon + :width: 25px + :class: desktop-status-icon + +Open the tray or menu bar icon to view the client and its available actions, such as pausing or resuming sync. + +File manager overlay icons -------------------------- -The Nextcloud sync client provides overlay icons, in addition to the normal file -type icons, for your system file manager (Explorer on Windows, Finder on Mac and -Nautilus on Linux) to indicate the sync status of your Nextcloud files. - -The overlay icons are similar to the systray icons introduced above. They -behave differently on files and directories according to sync status -and errors. - -The overlay icon of an individual file indicates its current sync state. If the -file is in sync with the server version, it displays a green checkmark. - -If the file is ignored from syncing, for example because it is on your -exclude list, or because it is a symbolic link, it displays a warning icon. - -If there is a sync error, or the file is blacklisted, it displays an -eye-catching red X. - -If the file is waiting to be synced, or is currently syncing, the overlay -icon displays a blue cycling icon. - -When the client is offline, no icons are shown to reflect that the -folder is currently out of sync and no changes are synced to the server. - -The overlay icon of a synced directory indicates the status of the files in the -directory. If there are any sync errors, the directory is marked with a warning -icon. - -If a directory includes ignored files that are marked with warning icons -that does not change the status of the parent directories. - -Set the user status -------------------- - -If you have the user status app installed on your Nextcloud server, -you can set your user status from the desktop client. To do so, open -the main dialog. Then click on your avatar and then click on the three -dots. In the menu that opens click on **Set status**. - -.. figure:: images/user_status_selector_main_dialog.png - :alt: Open user status dialog from main dialog. - -In the dialog that opens, you can set your online status if -you click on either **Online**, **Away**, **Do not disturb** or -**Invisible**. You can also set a custom status message with the text -field below or choose one of the predefined status messages below. It -is also possible to set a custom emoji if you click on the button with -the emoji beside the text input field. The last thing you might want -to set is when your user status should be cleared. You can choose the -period after which the user status will be cleared by clicking on the -button on the left hand side of the text **Clear status message after**. - -.. figure:: images/user_status-selector_dialog.png - :alt: Dialog to set user status. - -If you are happy with the status you have created you can enable this -status with the button **Set status message**. If you had already a -status set, you can clear the status by clicking the cutton **Clear -status message**. - -Sharing From Your Desktop -------------------------- - -The Nextcloud desktop sync client integrates with your file manager. Finder on -macOS and Explorer on Windows. Linux users must install an additional package -depending on the used file manager. Available are e.g. ``nautilus-nextcloud`` -(Ubuntu/Debian), ``dolphin-nextcloud`` (Kubuntu), ``nemo-nextcloud`` and -``caja-nextcloud``. You can create share links, and share with internal -Nextcloud users the same way as in your Nextcloud Web interface. - -In your file explorer, click on a file and in the context menu go to -**Nextcloud** and then click on **Share options** to bring up the Share -dialog. - -.. figure:: images/share_context_menu.png - :alt: Sharing from Windows Explorer. - -From this dialog you can share a file. - -.. figure:: images/share_dialog.png - :alt: Share dialog - - -General Window --------------- - -The General window has configuration options such as **Launch on System -Startup**, **Use Monochrome Icons**, and **Show Server Notifications**. This -is where you will find the **Edit Ignored Files** button, to launch the ignored -files editor, and **Ask confirmation before downloading -folders larger than [folder size]**. - -.. figure:: images/settings_general.png - :alt: General window contains configuration options. - -Using the Network Window ------------------------- - -.. index:: proxy settings, SOCKS, bandwidth, throttling, limiting - -The Network settings window enables you to define network proxy settings, and -also to limit download and upload bandwidth. - -.. figure:: images/settings_network.png - -.. _usingIgnoredFilesEditor-label: - -Using the Ignored Files Editor ------------------------------- - -.. index:: ignored files, exclude files, pattern - -You might have some local files or directories that you do not want to backup -and store on the server. To identify and exclude these files or directories, you -can use the *Ignored Files Editor* (General tab). +For classic sync folders, the desktop client adds overlay icons to files in the file manager. A green checkmark +means a file is up to date. A warning icon can mean that a file is ignored; a red X indicates a sync error. A blue +icon indicates a file waiting to sync or currently syncing. When the client is offline, it does not show overlays +for the folder's current sync state. -.. figure:: images/ignored_files_editor.png +A folder's overlay reflects sync errors in its contents. Ignored files do not change the parent folder's status. +On macOS, File Provider uses the standard Finder status indicators described in :doc:`macosfileprovider`. -For your convenience, the editor is pre-populated with a default list of -typical -ignore patterns. These patterns are contained in a system file (typically -``sync-exclude.lst``) located in the Nextcloud Client application directory. You -cannot modify these pre-populated patterns directly from the editor. However, -if -necessary, you can hover over any pattern in the list to show the path and -filename associated with that pattern, locate the file, and edit the -``sync-exclude.lst`` file. +Sharing +------- -.. note:: Modifying the global exclude definition file might render the client - unusable or result in undesired behavior. +The desktop client integrates sharing actions into Finder on macOS and Explorer on Windows. On Linux, install the +integration package for your file manager, such as ``nautilus-nextcloud`` or ``dolphin-nextcloud``. -Each line in the editor contains an ignore pattern string. When creating custom -patterns, in addition to being able to use normal characters to define an -ignore pattern, you can use wildcards characters for matching values. As an -example, you can use an asterisk (``*``) to identify an arbitrary number of -characters or a question mark (``?``) to identify a single character. +In your file manager, right-click a file and select **Nextcloud** > **Share options** to open the share dialog. -Patterns that end with a slash character (``/``) are applied to only directory -components of the path being checked. +Use **Search for recipients** to share the file with people or groups. Existing shares and share links appear below +the search field. Use the copy button to copy an internal link or share link. Use the three-dot menu to edit a share, +or the **X** button to remove it. -.. note:: Custom entries are currently not validated for syntactical - correctness by the editor, so you will not see any warnings for bad - syntax. If your synchronization does not work as you expected, check your - syntax. +.. image:: images/sharing-overview.png + :alt: Sharing overview with recipient search, existing shares, and link controls + :width: 50% + :align: center -Each pattern string in the list is followed by a checkbox. When the check box -contains a check mark, in addition to ignoring the file or directory component -matched by the pattern, any matched files are also deemed "fleeting metadata" -and removed by the client. +When you edit a share, choose the recipient's permission from the dropdown menu. You can also add a note for the +recipients. Changes are applied immediately. -In addition to excluding files and directories that use patterns defined in -this list: +.. image:: images/sharing-details.png + :alt: Share details with recipients, permissions, and a note to recipients + :width: 50% + :align: center -- The Nextcloud Client always excludes files containing characters that cannot - be synchronized to other file systems. +Open **Sharing settings** with the gear button to set an expiration date or protect the share with a password. +Changes are applied immediately. -- Files are removed that cause individual errors three times during a - synchronization. However, the client provides the option of retrying a - synchronization three additional times on files that produce errors. +.. image:: images/sharing-advanced-settings.png + :alt: Advanced sharing settings for expiration date and password protection + :width: 50% + :align: center