Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions _shared_assets/static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
48 changes: 48 additions & 0 deletions user_manual/desktop/client_features.rst
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions user_manual/desktop/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,19 +92,25 @@ 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**".

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).
Expand Down
Binary file added user_manual/desktop/images/activities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/assistant-chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed user_manual/desktop/images/icon-error.png
Binary file not shown.
Binary file removed user_manual/desktop/images/icon-information.png
Binary file not shown.
Binary file removed user_manual/desktop/images/icon-offline.png
Binary file not shown.
Binary file removed user_manual/desktop/images/icon-paused.png
Binary file not shown.
Binary file added user_manual/desktop/images/icon-status-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-status-ok.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-status-pause.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-status-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed user_manual/desktop/images/icon-syncing.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-tray-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-tray-offline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-tray-ok.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-tray-pause.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-tray-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/desktop/images/icon-tray-warning.png
Binary file removed user_manual/desktop/images/icon.png
Diff not rendered.
Binary file removed user_manual/desktop/images/ignored_files_editor.png
Diff not rendered.
Binary file removed user_manual/desktop/images/main_dialog.png
Diff not rendered.
Binary file added user_manual/desktop/images/search-results.png
Binary file added user_manual/desktop/images/settings-advanced.png
Binary file added user_manual/desktop/images/settings-general.png
Binary file added user_manual/desktop/images/settings-info.png
Binary file removed user_manual/desktop/images/settings_general.png
Diff not rendered.
Binary file removed user_manual/desktop/images/settings_network.png
Diff not rendered.
Binary file removed user_manual/desktop/images/settingsdialog.png
Diff not rendered.
Binary file removed user_manual/desktop/images/share_context_menu.png
Diff not rendered.
Binary file removed user_manual/desktop/images/share_dialog.png
Diff not rendered.
Binary file added user_manual/desktop/images/sharing-details.png
Binary file added user_manual/desktop/images/sharing-overview.png
Binary file removed user_manual/desktop/images/traymenu.png
Diff not rendered.
Binary file added user_manual/desktop/images/user-status.png
Diff not rendered.
Diff not rendered.
Binary file added user_manual/desktop/images/wizard-server.png
Binary file removed user_manual/desktop/images/wizard_advanced.png
Diff not rendered.
Binary file removed user_manual/desktop/images/wizard_flow2.png
Diff not rendered.
Binary file removed user_manual/desktop/images/wizard_setup.png
Diff not rendered.
Binary file removed user_manual/desktop/images/wizard_welcome.png
Diff not rendered.
3 changes: 2 additions & 1 deletion user_manual/desktop/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
59 changes: 8 additions & 51 deletions user_manual/desktop/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 10 additions & 0 deletions user_manual/desktop/macosfileprovider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand Down
Loading
Loading