mirror of
https://github.com/nextcloud/desktop.git
synced 2024-11-21 12:35:52 +03:00
Mac OS X is now macOS
Signed-off-by: Marius Blüm <marius@lineone.io>
This commit is contained in:
Marius Blüm
parent
f96206705a
commit
78bfae45ae
9 changed files with 180 additions and 181 deletions
|
|
@ -2,18 +2,18 @@
|
|||
The Automatic Updater
|
||||
=====================
|
||||
|
||||
The Automatic Updater ensures that you always have the
|
||||
The Automatic Updater ensures that you always have the
|
||||
latest features and bug fixes for your Nextcloud synchronization client.
|
||||
|
||||
The Automatic Updater updates only on Mac OS X 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
|
||||
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.
|
||||
|
||||
Basic Workflow
|
||||
--------------
|
||||
|
||||
The following sections describe how to use the Automatic Updater on different
|
||||
The following sections describe how to use the Automatic Updater on different
|
||||
operating systems.
|
||||
|
||||
Windows
|
||||
|
|
@ -29,20 +29,20 @@ itself. Should the silent update fail, the client offers a manual download.
|
|||
|
||||
.. note:: Administrative privileges are required to perform the update.
|
||||
|
||||
Mac OS X
|
||||
^^^^^^^^
|
||||
macOS
|
||||
^^^^^
|
||||
|
||||
If a new update is available, the Nextcloud client initializes a pop-up dialog
|
||||
to alert you of the update and requesting that you update to the latest
|
||||
version. Due to their use of the Sparkle frameworks, this is the default
|
||||
process for Mac OS X applications.
|
||||
process for macOS applications.
|
||||
|
||||
Linux
|
||||
^^^^^
|
||||
|
||||
Linux distributions provide their own update tools, so Nextcloud clients that use
|
||||
the Linux operating system do not perform any updates on their own. The client
|
||||
will inform you (``Settings -> General -> Updates``) when an update is
|
||||
the Linux operating system do not perform any updates on their own. The client
|
||||
will inform you (``Settings -> General -> Updates``) when an update is
|
||||
available.
|
||||
|
||||
Preventing Automatic Updates
|
||||
|
|
@ -57,14 +57,14 @@ auto-update mechanism for different operating systems.
|
|||
Preventing Automatic Updates in Windows Environments
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Users may disable automatic updates by adding this line to the [General]
|
||||
Users may disable automatic updates by adding this line to the [General]
|
||||
section of their ``nextcloud.cfg`` files::
|
||||
|
||||
skipUpdateCheck=true
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
To prevent automatic updates, but allow manual overrides:
|
||||
|
|
@ -82,7 +82,7 @@ To manually override this key, use the same value in ``HKEY_CURRENT_USER``.
|
|||
|
||||
To prevent automatic updates and disallow manual overrides:
|
||||
|
||||
.. note:: This is the preferred method of controlling the updater behavior using
|
||||
.. note:: This is the preferred method of controlling the updater behavior using
|
||||
Group Policies.
|
||||
|
||||
1. Edit this Registry key:
|
||||
|
|
@ -96,10 +96,10 @@ To prevent automatic updates and disallow manual overrides:
|
|||
.. note:: branded clients have different key names
|
||||
|
||||
|
||||
Preventing Automatic Updates in Mac OS X Environments
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Preventing Automatic Updates in macOS Environments
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can disable the automatic update mechanism, in the Mac OS X operating system,
|
||||
You can disable the automatic update mechanism, in the macOS operating system,
|
||||
by copying the file
|
||||
``nextcloud.app/Contents/Resources/deny_autoupdate_com.nextcloud.desktopclient.plist``
|
||||
to ``/Library/Preferences/com.nextcloud.desktopclient.plist``.
|
||||
|
|
|
|||
|
|
@ -16,14 +16,14 @@ These instructions are updated to work with version |version| of the Nextcloud C
|
|||
Getting Source Code
|
||||
-------------------
|
||||
|
||||
The :ref:`generic-build-instructions` pull the latest code directly from
|
||||
GitHub, and work on Linux, Mac OS X, and Windows.
|
||||
The :ref:`generic-build-instructions` pull the latest code directly from
|
||||
GitHub, and work on Linux, macOS, and Windows.
|
||||
|
||||
Mac OS X
|
||||
--------
|
||||
macOS
|
||||
-----
|
||||
|
||||
In addition to needing XCode (along with the command line tools), developing in
|
||||
the Mac OS X environment requires extra dependencies. You can install these
|
||||
the macOS environment requires extra dependencies. You can install these
|
||||
dependencies through MacPorts_ or Homebrew_. These dependencies are required
|
||||
only on the build machine, because non-standard libs are deployed in the app
|
||||
bundle.
|
||||
|
|
@ -60,14 +60,14 @@ To set up your build environment for development using HomeBrew_:
|
|||
Where ``x.y`` is the current version of Qt 5 that brew has installed
|
||||
on your machine.
|
||||
8. Install qtkeychain from here: git clone https://github.com/frankosterfeld/qtkeychain.git
|
||||
make sure you make the same install prefix as later while building the client e.g. -
|
||||
make sure you make the same install prefix as later while building the client e.g. -
|
||||
``DCMAKE_INSTALL_PREFIX=/Path/to/client-install``
|
||||
|
||||
9. For compilation of the client, follow the :ref:`generic-build-instructions`.
|
||||
|
||||
10. Install the Packages_ package creation tool.
|
||||
|
||||
11. In the build directory, run ``admin/osx/create_mac.sh <build_dir> <install_dir>``.
|
||||
11. In the build directory, run ``admin/osx/create_mac.sh <build_dir> <install_dir>``.
|
||||
If you have a developer signing certificate, you can specify
|
||||
its Common Name as a third parameter (use quotes) to have the package
|
||||
signed automatically.
|
||||
|
|
@ -137,7 +137,7 @@ is **currently only officially supported on openSUSE**, by using the MinGW cross
|
|||
You can set up any currently supported version of openSUSE in a virtual machine if you do not
|
||||
have it installed already.
|
||||
|
||||
In order to make setup simple, you can use the provided Dockerfile to build your own image.
|
||||
In order to make setup simple, you can use the provided Dockerfile to build your own image.
|
||||
|
||||
1. Assuming you are in the root of the Nextcloud Client's source tree, you can
|
||||
build an image from this Dockerfile like this::
|
||||
|
|
@ -209,24 +209,24 @@ To build the most up-to-date version of the client:
|
|||
3. Configure the client build::
|
||||
|
||||
cmake -DCMAKE_BUILD_TYPE="Debug" ..
|
||||
|
||||
|
||||
.. note:: You must use absolute paths for the ``include`` and ``library``
|
||||
directories.
|
||||
|
||||
.. note:: On Mac OS X, you need to specify ``-DCMAKE_INSTALL_PREFIX=target``,
|
||||
.. note:: On macOS, you need to specify ``-DCMAKE_INSTALL_PREFIX=target``,
|
||||
where ``target`` is a private location, i.e. in parallel to your build
|
||||
dir by specifying ``../install``.
|
||||
|
||||
|
||||
.. note:: qtkeychain must be compiled with the same prefix e.g ``CMAKE_INSTALL_PREFIX=/Users/path/to/client/install/ .``
|
||||
|
||||
|
||||
.. note:: Example:: ``cmake -DCMAKE_PREFIX_PATH=/usr/local/opt/qt5 -DCMAKE_INSTALL_PREFIX=/Users/path/to/client/install/ -DNO_SHIBBOLETH=1``
|
||||
|
||||
|
||||
4. Call ``make``.
|
||||
|
||||
The Nextcloud binary will appear in the ``bin`` directory.
|
||||
|
||||
5. (Optional) Call ``make install`` to install the client to the
|
||||
``/usr/local/bin`` directory.
|
||||
|
||||
5. (Optional) Call ``make install`` to install the client to the
|
||||
``/usr/local/bin`` directory.
|
||||
|
||||
The following are known cmake parameters:
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ On Linux distributions:
|
|||
On Microsoft Windows systems:
|
||||
``%APPDATA%\Nextcloud\nextcloud.cfg``
|
||||
|
||||
On MAC OS X systems:
|
||||
On macOS systems:
|
||||
``$HOME/Library/Preferences/Nextcloud/nextcloud.cfg``
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Glossary
|
|||
Nextcloud Sync Client
|
||||
Nextcloud Client
|
||||
Name of the official Nextcloud syncing client for desktop, which runs on
|
||||
Windows, Mac OS X and Linux. It uses the CSync sync engine for
|
||||
Windows, macOS and Linux. It uses the CSync sync engine for
|
||||
synchronization with the Nextcloud server.
|
||||
|
||||
Nextcloud Server
|
||||
|
|
|
|||
|
|
@ -2,69 +2,69 @@
|
|||
Installing the Desktop Synchronization Client
|
||||
=============================================
|
||||
|
||||
You can download the latest version of the Nextcloud Desktop Synchronization
|
||||
Client from the `Nextcloud download page`_.
|
||||
There are clients for Linux, Mac OS X, and Microsoft Windows.
|
||||
You can download the latest version of the Nextcloud Desktop Synchronization
|
||||
Client from the `Nextcloud download page`_.
|
||||
There are clients for Linux, macOS, and Microsoft Windows.
|
||||
|
||||
Installation on Mac OS X and Windows is the same as for any software
|
||||
application: download the program and then double-click it to launch the
|
||||
installation, and then follow the installation wizard. After it is installed and
|
||||
configured the sync client will automatically keep itself updated; see
|
||||
Installation on macOS and Windows is the same as for any software
|
||||
application: download the program and then double-click it to launch the
|
||||
installation, and then follow the installation wizard. After it is installed and
|
||||
configured the sync client will automatically keep itself updated; see
|
||||
:doc:`autoupdate` for more information.
|
||||
|
||||
Linux users must follow the instructions on the download page to add the
|
||||
appropriate repository for their Linux distribution, install the signing key,
|
||||
and then use their package managers to install the desktop sync client. Linux
|
||||
users will also update their sync clients via package manager, and the client
|
||||
will display a notification when an update is available.
|
||||
Linux users must follow the instructions on the download page to add the
|
||||
appropriate repository for their Linux distribution, install the signing key,
|
||||
and then use their package managers to install the desktop sync client. Linux
|
||||
users will also update their sync clients via package manager, and the client
|
||||
will display a notification when an update is available.
|
||||
|
||||
Linux users must also have a password manager enabled, such as GNOME Keyring or
|
||||
KWallet, so that the sync client can login automatically.
|
||||
|
||||
You will also find links to source code archives and older versions on the
|
||||
You will also find links to source code archives and older versions on the
|
||||
download page.
|
||||
|
||||
System Requirements
|
||||
----------------------------------
|
||||
|
||||
- Windows 7+
|
||||
- Mac OS X 10.7+ (**64-bit only**)
|
||||
- macOS 10.7+ (**64-bit only**)
|
||||
|
||||
Installation Wizard
|
||||
-------------------
|
||||
|
||||
The installation wizard takes you step-by-step through configuration options and
|
||||
The installation wizard takes you step-by-step through configuration options and
|
||||
account setup. First you need to enter the URL of your Nextcloud server.
|
||||
|
||||
.. image:: images/client-1.png
|
||||
:alt: form for entering Nextcloud server URL
|
||||
|
||||
|
||||
Enter your Nextcloud login on the next screen.
|
||||
|
||||
.. image:: images/client-2.png
|
||||
:alt: form for entering your Nextcloud login
|
||||
|
||||
On the Local Folder Option 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
|
||||
On the Local Folder Option 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.
|
||||
|
||||
.. image:: images/client-3.png
|
||||
:alt: Select which remote folders to sync, and which local folder to store
|
||||
:alt: Select which remote folders to sync, and which local folder to store
|
||||
them in.
|
||||
|
||||
When you have completed selecting your sync folders, click the Connect button
|
||||
at the bottom right. The client will attempt to connect to your Nextcloud
|
||||
server, and when it is successful you'll see two buttons: one to connect to
|
||||
your Nextcloud Web GUI, and one to open your local folder. It will also start
|
||||
|
||||
When you have completed selecting your sync folders, click the Connect button
|
||||
at the bottom right. The client will attempt to connect to your Nextcloud
|
||||
server, and when it is successful you'll see two buttons: one to connect to
|
||||
your Nextcloud Web GUI, and one to open your local folder. It will also start
|
||||
synchronizing your files.
|
||||
|
||||
.. image:: images/client-4.png
|
||||
:alt: A successful server connection, showing a button to connect to your
|
||||
:alt: A successful server connection, showing a button to connect to your
|
||||
Web GUI, and one to open your local Nextcloud folder
|
||||
|
||||
Click the Finish button, and you're all done.
|
||||
Click the Finish button, and you're all done.
|
||||
|
||||
.. Links
|
||||
|
||||
|
||||
.. _Nextcloud download page: https://nextcloud.com/download/#install-clients
|
||||
|
|
|
|||
|
|
@ -2,27 +2,26 @@
|
|||
Introduction
|
||||
============
|
||||
|
||||
Available for Windows, Mac OS X, and various Linux distributions, the Nextcloud
|
||||
Available for Windows, macOS, and various Linux distributions, the Nextcloud
|
||||
Desktop Sync client enables you to:
|
||||
|
||||
- Specify one or more directories on your computer that you want to synchronize
|
||||
to the Nextcloud server.
|
||||
- Always have the latest files synchronized, wherever they are located.
|
||||
|
||||
Your files are always automatically synchronized between your Nextcloud server
|
||||
Your files are always automatically synchronized between your Nextcloud server
|
||||
and local PC.
|
||||
|
||||
Improvements and New Features
|
||||
-----------------------------
|
||||
|
||||
The |version| release of the Nextcloud desktop sync client has many new features and
|
||||
The |version| release of the Nextcloud desktop sync client has many new features and
|
||||
improvements.
|
||||
|
||||
|
||||
* Show server notifications on the client
|
||||
* Improved sync speed
|
||||
* Improved handling of Win32 file locks and network files
|
||||
* Improved handling of Win32 file locks and network files
|
||||
* Improved user notifications about ignored files and conflicts
|
||||
* Add warnings for old server versions
|
||||
* Update of QtKeyChain to support Windows credential store
|
||||
* Packaging of dolphin overlay icon module for bleeding edge distributions
|
||||
|
||||
|
|
|
|||
|
|
@ -4,15 +4,15 @@ Using the Synchronization Client
|
|||
|
||||
.. index:: navigating, usage
|
||||
|
||||
The Nextcloud Desktop Client remains in the background and is visible as an icon
|
||||
in the system tray (Windows, KDE), status bar (Mac OS X), or notification area
|
||||
The Nextcloud Desktop Client remains in the background and is visible as an icon
|
||||
in the system tray (Windows, KDE), status bar (macOS), or notification area
|
||||
(Linux).
|
||||
|
||||
.. figure:: images/icon.png
|
||||
:alt: Status icon, green circle and white checkmark
|
||||
:alt: Status icon, green circle and white checkmark
|
||||
|
||||
The status indicator uses icons to indicate the current status of your
|
||||
synchronization. The green circle with the white checkmark tells you that your
|
||||
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.
|
||||
|
||||
.. figure:: images/icon-syncing.png
|
||||
|
|
@ -21,35 +21,35 @@ synchronization is current and you are connected to your Nextcloud server.
|
|||
The blue icon with the white semi-circles means synchronization is in progress.
|
||||
|
||||
.. figure:: images/icon-paused.png
|
||||
:alt: Status icon, yellow circle and vertical parallel
|
||||
:alt: Status icon, yellow circle and vertical parallel
|
||||
lines
|
||||
|
||||
The yellow icon with the parallel lines tells you your synchronization
|
||||
The yellow icon with the parallel lines tells you your synchronization
|
||||
has been paused. (Most likely by you.)
|
||||
|
||||
.. figure:: images/icon-offline.png
|
||||
:alt: Status icon, gray circle and three horizontal
|
||||
:alt: Status icon, gray circle and three horizontal
|
||||
white dots
|
||||
|
||||
The gray icon with three white dots means your sync client has lost its
|
||||
The gray icon with three white dots means your sync client has lost its
|
||||
connection with your Nextcloud server.
|
||||
|
||||
.. figure:: images/icon-information.png
|
||||
:alt: Status icon, sign "!" in yellow circle
|
||||
|
||||
When you see a yellow circle with the sign "!" that is the informational icon,
|
||||
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.
|
||||
|
||||
.. figure:: images/icon-error.png
|
||||
:alt: Status icon, red circle and white x
|
||||
|
||||
The red circle with the white "x" indicates a configuration error, such as an
|
||||
The red circle with the white "x" indicates a configuration error, such as an
|
||||
incorrect login or server URL.
|
||||
|
||||
Systray Icon
|
||||
------------
|
||||
|
||||
A right-click on the systray icon opens a menu for quick access to multiple
|
||||
A right-click on the systray icon opens a menu for quick access to multiple
|
||||
operations.
|
||||
|
||||
.. figure:: images/menu.png
|
||||
|
|
@ -66,7 +66,7 @@ This menu provides the following options:
|
|||
* An option to log in or log out of all of your accounts at once
|
||||
* Quit Nextcloud, logging out and closing the client
|
||||
|
||||
A left-click on your systray icon opens the desktop client to the account
|
||||
A left-click on your systray icon opens the desktop client to the account
|
||||
settings window.
|
||||
|
||||
.. figure:: images/client-6.png
|
||||
|
|
@ -77,151 +77,151 @@ Configuring Nextcloud Account Settings
|
|||
|
||||
.. index:: account settings, user, password, Server URL
|
||||
|
||||
At the top of the window are tabs for each configured sync account, and three
|
||||
others for Activity, General and Network settings. On your account tabs you
|
||||
At the top of the window are tabs for each configured sync account, and three
|
||||
others for Activity, General and Network settings. On your account tabs you
|
||||
have the following features:
|
||||
|
||||
* Connection status, showing which Nextcloud server you are connected to, and
|
||||
* Connection status, showing which Nextcloud server you are connected to, and
|
||||
your Nextcloud username.
|
||||
* An **Account** button, which contains a dropdown menu with **Add New**,
|
||||
* An **Account** button, which contains a dropdown menu with **Add New**,
|
||||
**Log Out**, and **Remove**.
|
||||
* Used and available space on the server.
|
||||
* Current synchronization status.
|
||||
* **Add Folder Sync Connection** button.
|
||||
|
||||
The little button with three dots (the overflow menu) that sits to the right of
|
||||
The little button with three dots (the overflow menu) that sits to the right of
|
||||
the sync status bar offers four additional options:
|
||||
|
||||
* Open Folder
|
||||
* Choose What to Sync (This appears only when your file tree is collapsed, and
|
||||
* 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
|
||||
|
||||
**Open Folder** opens your local Nextcloud sync folder.
|
||||
|
||||
**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
|
||||
**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**.
|
||||
|
||||
.. figure:: images/client-7.png
|
||||
:alt: Extra options for sync operations
|
||||
|
||||
.. 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
|
||||
<https://github.com/owncloud/core/issues/7009>`_ for discussion of this.
|
||||
|
||||
|
||||
.. 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
|
||||
<https://github.com/owncloud/core/issues/7009>`_ for discussion of this.
|
||||
|
||||
Adding New Accounts
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
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
|
||||
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 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
|
||||
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
|
||||
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
|
||||
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.
|
||||
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
|
||||
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
|
||||
If a directory includes ignored files that are marked with warning icons
|
||||
that does not change the status of the parent directories.
|
||||
|
||||
Sharing From Your Desktop
|
||||
-------------------------
|
||||
|
||||
The Nextcloud desktop sync client integrates with your file manager: Finder on
|
||||
Mac OS X, Explorer on Windows, and Nautilus on Linux. (Linux users must install
|
||||
the ``Nextcloud-client-nautilus`` plugin.) You can create share links, and share
|
||||
The Nextcloud desktop sync client integrates with your file manager: Finder on
|
||||
macOS, Explorer on Windows, and Nautilus on Linux. (Linux users must install
|
||||
the ``Nextcloud-client-nautilus`` plugin.) You can create share links, and share
|
||||
with internal Nextcloud users the same way as in your Nextcloud Web interface.
|
||||
|
||||
.. figure:: images/mac-share.png
|
||||
:alt: Sync client integration in Windows Explorer.
|
||||
|
||||
Right-click your systray icon, hover over the account you want to use, and
|
||||
left-click "Open folder [folder name] to quickly enter your local Nextcloud
|
||||
folder. Right-click the file or folder you want to share to expose the share
|
||||
|
||||
Right-click your systray icon, hover over the account you want to use, and
|
||||
left-click "Open folder [folder name] to quickly enter your local Nextcloud
|
||||
folder. Right-click the file or folder you want to share to expose the share
|
||||
dialog, and click **Share with Nextcloud**.
|
||||
|
||||
.. figure:: images/share-1.png
|
||||
:alt: Sharing from Windows Explorer.
|
||||
|
||||
|
||||
The share dialog has all the same options as your Nextcloud Web interface.
|
||||
|
||||
.. figure:: images/share-2.png
|
||||
:alt: Share dialog in Windows Explorer.
|
||||
|
||||
Use **Share with Nextcloud** to see who you have shared with, and to modify
|
||||
their permissions, or to delete the share.
|
||||
|
||||
Use **Share with Nextcloud** to see who you have shared with, and to modify
|
||||
their permissions, or to delete the share.
|
||||
|
||||
Activity Window
|
||||
---------------
|
||||
|
||||
The Activity window contains the log of your recent activities, organized over
|
||||
three tabs: **Server Activities**, which includes new shares and files
|
||||
downloaded and deleted, **Sync Protocol**, which displays local activities such
|
||||
as which local folders your files went into, and **Not Synced** shows errors
|
||||
The Activity window contains the log of your recent activities, organized over
|
||||
three tabs: **Server Activities**, which includes new shares and files
|
||||
downloaded and deleted, **Sync Protocol**, which displays local activities such
|
||||
as which local folders your files went into, and **Not Synced** shows errors
|
||||
such as files not synced. Double clicking an entry pointing to an existing
|
||||
file in **Server Activities** or **Sync Protocol** will open the folder containing
|
||||
the file and highlight it.
|
||||
|
||||
.. figure:: images/client-8.png
|
||||
:alt: Activity windows logs all server and client activities.
|
||||
|
||||
|
||||
Server Notifications
|
||||
--------------------
|
||||
|
||||
Starting with version 2.2.0, the client will display notifications from your
|
||||
Nextcloud server that require manual interaction by you. For example, when a
|
||||
user on a remote Nextcloud creates a new Federated share for you, you can accept
|
||||
Starting with version 2.2.0, the client will display notifications from your
|
||||
Nextcloud server that require manual interaction by you. For example, when a
|
||||
user on a remote Nextcloud creates a new Federated share for you, you can accept
|
||||
it from your desktop client.
|
||||
|
||||
The desktop client automatically checks for available notifications
|
||||
automatically on a regular basis. Notifications are displayed in the Server
|
||||
Activity tab, and if you have **Show Desktop Notifications** enabled (General
|
||||
The desktop client automatically checks for available notifications
|
||||
automatically on a regular basis. Notifications are displayed in the Server
|
||||
Activity tab, and if you have **Show Desktop Notifications** enabled (General
|
||||
tab) you'll also see a systray notification.
|
||||
|
||||
.. figure:: images/client-12.png
|
||||
:alt: Activity window with notification.
|
||||
|
||||
This also displays notifications sent to users by the Nextcloud admin via the
|
||||
This also displays notifications sent to users by the Nextcloud admin via the
|
||||
Announcements app.
|
||||
|
||||
General Window
|
||||
--------------
|
||||
|
||||
The General window has configuration options such as **Launch on System
|
||||
Startup**, **Use Monochrome Icons**, and **Show Desktop Notifications**. This
|
||||
is where you will find the **Edit Ignored Files** button, to launch the ignored
|
||||
files editor, and **Ask confirmation before downloading
|
||||
The General window has configuration options such as **Launch on System
|
||||
Startup**, **Use Monochrome Icons**, and **Show Desktop 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/client-9.png
|
||||
|
|
@ -232,7 +232,7 @@ Using the Network Window
|
|||
|
||||
.. index:: proxy settings, SOCKS, bandwith, throttling, limiting
|
||||
|
||||
The Network settings window enables you to define network proxy settings, and
|
||||
The Network settings window enables you to define network proxy settings, and
|
||||
also to limit download and upload bandwidth.
|
||||
|
||||
.. figure:: images/settings_network.png
|
||||
|
|
@ -244,20 +244,20 @@ 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
|
||||
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.)
|
||||
|
||||
.. figure:: images/ignored_files_editor.png
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
.. note:: Modifying the global exclude definition file might render the client
|
||||
|
|
@ -267,14 +267,14 @@ 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.
|
||||
characters or a question mark (``?``) to identify a single character.
|
||||
|
||||
Patterns that end with a slash character (``/``) are applied to only directory
|
||||
components of the path being checked.
|
||||
|
||||
.. 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. If your synchronization does not work as you expected, check your
|
||||
syntax.
|
||||
|
||||
Each pattern string in the list is preceded by a checkbox. When the check box
|
||||
|
|
@ -288,8 +288,8 @@ this list:
|
|||
- The Nextcloud Client always excludes files containing characters that cannot
|
||||
be synchronized to other file systems.
|
||||
|
||||
- Files are removed that cause individual errors three times during a
|
||||
synchronization. However, the client provides the option of retrying a
|
||||
- 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.
|
||||
|
||||
For more detailed information see :ref:`ignored-files-label`.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Appendix C: Troubleshooting
|
|||
The following two general issues can result in failed synchronization:
|
||||
|
||||
- The server setup is incorrect.
|
||||
- The client contains a bug.
|
||||
- The client contains a bug.
|
||||
|
||||
When reporting bugs, it is helpful if you first determine what part of the
|
||||
system is causing the issue.
|
||||
|
|
@ -16,7 +16,7 @@ Identifying Basic Functionality Problems
|
|||
The first step in troubleshooting synchronization issues is to verify that
|
||||
you can log on to the Nextcloud web application. To verify connectivity to the
|
||||
Nextcloud server try logging in via your Web browser.
|
||||
|
||||
|
||||
If you are not prompted for your username and password, or if a red warning
|
||||
box appears on the page, your server setup requires modification. Please verify
|
||||
that your server installation is working correctly.
|
||||
|
|
@ -30,7 +30,7 @@ Identifying Basic Functionality Problems
|
|||
Verify that you can log on to Nextcloud's WebDAV server. To verify connectivity
|
||||
with the Nextcloud WebDAV server:
|
||||
|
||||
- Open a browser window and enter the address to the Nextcloud WebDAV server.
|
||||
- Open a browser window and enter the address to the Nextcloud WebDAV server.
|
||||
|
||||
For example, if your Nextcloud instance is installed at
|
||||
``http://yourserver.com/nextcloud``, your WebDAV server address is
|
||||
|
|
@ -40,29 +40,29 @@ Identifying Basic Functionality Problems
|
|||
correct credentials, authentication fails, please ensure that your
|
||||
authentication backend is configured properly.
|
||||
|
||||
:Use a WebDAV command line tool to test:
|
||||
:Use a WebDAV command line tool to test:
|
||||
A more sophisticated test method for troubleshooting synchronization issues
|
||||
is to use a WebDAV command line client and log into the Nextcloud WebDAV server.
|
||||
One such command line client -- called ``cadaver`` -- is available for Linux
|
||||
distributions. You can use this application to further verify that the WebDAV
|
||||
server is running properly using PROPFIND calls.
|
||||
server is running properly using PROPFIND calls.
|
||||
|
||||
As an example, after installing the ``cadaver`` app, you can issue the
|
||||
``propget`` command to obtain various properties pertaining to the current
|
||||
directory and also verify WebDAV server connection.
|
||||
|
||||
|
||||
"CSync unknown error"
|
||||
---------------------
|
||||
|
||||
If you see this error message stop your client, delete the
|
||||
``._sync_xxxxxxx.db`` file, and then restart your client.
|
||||
There is a hidden ``._sync_xxxxxxx.db`` file inside the folder of every account
|
||||
configured on your client.
|
||||
configured on your client.
|
||||
|
||||
.. NOTE::
|
||||
Please note that this will also erase some of your settings about which
|
||||
files to download.
|
||||
|
||||
|
||||
See https://github.com/owncloud/client/issues/5226 for more discussion of this
|
||||
issue.
|
||||
|
||||
|
|
@ -145,7 +145,7 @@ mentioned above to save the log to a file.
|
|||
restarting the client using the following command:
|
||||
|
||||
* Windows: ``C:\Program Files (x86)\Nextcloud\nextcloud.exe --logwindow``
|
||||
* Mac OS X: ``/Applications/nextcloud.app/Contents/MacOS/nextcloud --logwindow``
|
||||
* macOS: ``/Applications/nextcloud.app/Contents/MacOS/nextcloud --logwindow``
|
||||
* Linux: ``nextcloud --logwindow``
|
||||
|
||||
Saving Files Directly
|
||||
|
|
@ -184,7 +184,7 @@ The Nextcloud server also maintains an Nextcloud specific log file. This log fil
|
|||
must be enabled through the Nextcloud Administration page. On that page, you can
|
||||
adjust the log level. We recommend that when setting the log file level that
|
||||
you set it to a verbose level like ``Debug`` or ``Info``.
|
||||
|
||||
|
||||
You can view the server log file using the web interface or you can open it
|
||||
directly from the file system in the Nextcloud server data directory.
|
||||
|
||||
|
|
@ -202,21 +202,21 @@ Nextcloud-related problems. For Apache on Linux, the error logs are typically
|
|||
located in the ``/var/log/apache2`` directory. Some helpful files include the
|
||||
following:
|
||||
|
||||
- ``error_log`` -- Maintains errors associated with PHP code.
|
||||
- ``error_log`` -- Maintains errors associated with PHP code.
|
||||
- ``access_log`` -- Typically records all requests handled by the server; very
|
||||
useful as a debugging tool because the log line contains information specific
|
||||
to each request and its result.
|
||||
|
||||
|
||||
You can find more information about Apache logging at
|
||||
``http://httpd.apache.org/docs/current/logs.html``.
|
||||
|
||||
Core Dumps
|
||||
----------
|
||||
|
||||
On Mac OS X and Linux systems, and in the unlikely event the client software
|
||||
On macOS and Linux systems, and in the unlikely event the client software
|
||||
crashes, the client is able to write a core dump file. Obtaining a core dump
|
||||
file can assist Nextcloud Customer Support tremendously in the debugging
|
||||
process.
|
||||
process.
|
||||
|
||||
To enable the writing of core dump files, you must define the
|
||||
``OWNCLOUD_CORE_DUMP`` environment variable on the system.
|
||||
|
|
@ -228,7 +228,7 @@ OWNCLOUD_CORE_DUMP=1 nextcloud
|
|||
```
|
||||
|
||||
This command starts the client with core dumping enabled and saves the files in
|
||||
the current working directory.
|
||||
the current working directory.
|
||||
|
||||
.. note:: Core dump files can be fairly large. Before enabling core dumps on
|
||||
your system, ensure that you have enough disk space to accommodate these files.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Icon
|
|||
|
||||
The Nextcloud Client remains in the background and is visible
|
||||
as an icon in the system tray (Windows, KDE), status bar
|
||||
(MAC OS X), or notification area (Ubuntu).
|
||||
(macOS), or notification area (Ubuntu).
|
||||
|
||||
.. image:: images/icon.png
|
||||
|
||||
|
|
@ -17,7 +17,7 @@ Menu
|
|||
|
||||
.. image:: images/menu.png
|
||||
|
||||
A right click on the icon (left click on Ubuntu and Mac OS X)
|
||||
A right click on the icon (left click on Ubuntu and macOS)
|
||||
provides the following menu:
|
||||
|
||||
* ``Open Nextcloud in browser``: Opens the Nextcloud web interface
|
||||
|
|
@ -124,7 +124,7 @@ The tab provides several useful options:
|
|||
* ``Show Desktop Nofications``: When checked, bubble notifications when
|
||||
a set of sync operations has been performed are provided.
|
||||
* ``Use Monochrome Icons``: Use less obtrusive icons. Especially useful
|
||||
on Mac OS X.
|
||||
on macOS.
|
||||
* ``About``: provides information about authors as well as build conditions.
|
||||
This information is valuable when submitting a support request.
|
||||
|
||||
|
|
@ -179,11 +179,11 @@ The Ignored Files Editor
|
|||
.. index:: ignored files, exclude files, pattern
|
||||
|
||||
Nextcloud Client has the ability to exclude files from the sync process.
|
||||
The ignored files editor allows editing of custom patterns for files or
|
||||
directories that should be excluded from the sync process.
|
||||
The ignored files editor allows editing of custom patterns for files or
|
||||
directories that should be excluded from the sync process.
|
||||
|
||||
There is a system wide list of default ignore patterns. These global defaults
|
||||
cannot be directly modified within the editor. Hovering with the mouse will
|
||||
There is a system wide list of default ignore patterns. These global defaults
|
||||
cannot be directly modified within the editor. Hovering with the mouse will
|
||||
reveal the location of the global exclude definition file.
|
||||
|
||||
.. image:: images/ignored_files_editor.png
|
||||
|
|
@ -206,9 +206,9 @@ which are matched by this pattern are fleeting metadata which the client will
|
|||
correctness by the editor, but might fail to load correctly.
|
||||
|
||||
In addition to this list, Nextcloud Client always excludes files with
|
||||
characters that cannot be synced to other file systems.
|
||||
characters that cannot be synced to other file systems.
|
||||
|
||||
With version 1.5.0 it also ignores files that caused individual errors
|
||||
With version 1.5.0 it also ignores files that caused individual errors
|
||||
while syncing for a three times. These are listed in the activity view.
|
||||
There also is a button to retry the sync for another three times.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue