mirrors/nextcloud-desktop
1
0
Fork 0
mirror of https://github.com/nextcloud/desktop.git synced 2024-11-21 20:45:51 +03:00
Code Issues Projects Releases Packages Wiki Activity

Documentation update from Mark.

Browse source
This commit is contained in:
Daniel Molkentin 2014-06-25 22:04:33 +02:00
parent 9adc30ab9f
commit 23e0af5cc1
45 changed files with 1218 additions and 468 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
doc/accountsetup.rst
View file

@ -1,45 +1,42 @@
Setting up an Account
=====================
If no account has been configured, the ownCloud Client will automatically
assist in connecting to your ownCloud server after the application has been
started.
If no account has been configured, the ownCloud Client automatically assist in
connecting to your ownCloud server after the application has been started.
As a first step, specify the URL to your Server. This is the same address
that is used in the browser.
To set up an account:
1. Specify the URL to your Server. This is the same address that is used in the browser.
.. image:: images/wizard_url.png
:scale: 50 %
.. note:: Make sure to use ``https://`` if the server supports it. Otherwise,
your password and all data will be transferred to the server unencrypted.
This makes it easy for third parties to intercept your communication, and
getting hold of your password!
your password and all data will be transferred to the server unencrypted. This
makes it easy for third parties to intercept your communication, and getting
hold of your password!
Next, enter the username and password. These are the same credentials used
to log into the web interface.
2. Enter the username and password. These are the same credentials used to log into the web interface.
.. image:: images/wizard_user.png
:scale: 50 %
Finally, choose the folder that ownCloud Client is supposed to sync the
contents of your ownCloud account with. By default, this is a folder
called `ownCloud`, which will be created in the home directory.
3. Choose the folder with which you want the ownCloud Client to synchronize the
contents of your ownCloud account. By default, this is a folder called
`ownCloud`. This folder is created in the home directory.
.. image:: images/wizard_targetfolder.png
:scale: 50 %
At this time, the synchronization between the root directories of the
ownCloud server will begin.
The synchronization between the root directories of the ownCloud server begins.
.. image:: images/wizard_overview.png
:scale: 50 %
If selecting a local folder that already contains data, there are
two options that exist.
When selecting a local folder that already contains data, you can choose from two options:
* Keep local data: If selected, the files in the local folder on the
client will be synced up to the ownCloud server.
* Start a clean sync: If selected, all files in the local folder on
the client will be deleted and therefore not synced to the ownCloud
server.
* :guilabel:`Keep local data`: When selected, the files in the local folder on
the client are synchronized to the ownCloud server.
* :guilabel:`Start a clean sync`: When selected, all files in the local folder on the
client are deleted. These files are not syncrhonized to the ownCloud server.

249
doc/architecture.rst
View file

@ -1,88 +1,96 @@
Appendix B: Architecture
========================
Appendix B: History and Architecture
====================================
.. index:: architecture
.. index:: architecture
The ownCloud project provides desktop sync clients to synchronize the
contents of local directories on the desktop machines to the ownCloud.
ownCloud provides desktop sync clients to synchronize the contents of local
directories from computers, tablets, and handheld devices to the ownCloud
server.
The syncing is done with csync_, a bidirectional file synchronizing tool which
provides both a command line client as well as a library. A special module for
csync was written to synchronize with ownCloud’s built-in WebDAV server.
Synchronization is accomplished using csync_, a bidirectional file
synchronizing tool that provides both a command line client as well as a
library. A special module for csync was written to synchronize with the
ownCloud built-in WebDAV server.
The ownCloud sync client is based on a tool called mirall initially written by
Duncan Mac Vicar. Later Klaas Freitag joined the project and enhanced it to work
with ownCloud server.
The ownCloud sync client is based on a tool called *mirall*, initially written
by Duncan Mac Vicar. Later Klaas Freitag joined the project and enhanced it to
function with the ownCloud server.
ownCloud Client is written in C++ using the `Qt Framework`_. As a result, the
ownCloud Client runs on the three important platforms Linux, Windows and MacOS.
The ownCloud Client software is written in C++ using the `Qt Framework`_. As a
result, the ownCloud Client runs on Linux, Windows, and MacOS.
.. _csync: http://www.csync.org
.. _`Qt Framework`: http://www.qt-project.org
The Sync Process
----------------
The Synchronization Process
---------------------------
First it is important to recall what syncing is: It tries to keep the files
on two repositories the same. That means if a file is added to one repository
it is going to be copied to the other repository. If a file is changed on one
repository, the change is propagated to the other repository. Also, if a file
is deleted on one side, it is deleted on the other. As a matter of fact, in
ownCloud syncing we do not have a typical client/server system where the
server is always master.
The process of synchronization keeps files in two separate repositories the same. When syncrhonized:
This is the major difference to other systems like a file backup where just
changes and new files are propagated but files never get deleted.
- If a file is added to one repository it is copied to the other synchronized repository.
- When a file is changed in one repository, the change is propagated to any
syncrhonized other repositories- If a file is deleted in one repository, it
is deleted in any other.
The ownCloud Client checks both repositories for changes frequently after a
certain time span. That is refered to as a sync run. In between the local
repository is monitored by a file system monitor system that starts a sync run
immediately if something was edited, added or removed.
It is important to note that the ownCloud synchronization process does not use
a typical client/server system where the server is always master. This is a
major difference between the ownCloud syncrhonizatin process and other systems
like a file backup, where only changes to files or folders and the addition of
new files are propagated, but these files and folders are never deleted unless
explicitly deleted in the backup.
Sync by Time versus ETag
------------------------
.. index:: time stamps, file times, etag, unique id
During synchronization, the ownCloud Client checks both repositories for
changes frequently. This process is referred to as a *sync run*. In between
sync runs, the local repository is monitored by a file system monitoring
process that starts a sync run immediately if something was edited, added, or
removed.
Until the release of ownCloud 4.5 and ownCloud Client 1.1, ownCloud employed
a single file property to decide which file is newer and hence needs to be
synced to the other repository: the files modification time.
Synchronization by Time versus ETag
-----------------------------------
.. index:: time stamps, file times, etag, unique id
Until the release of ownCloud 4.5 and ownCloud Client 1.1, the ownCloud
synchronization process employed a single file property -- the file modificatin
time -- to decide which file was newer and needed to be synchronized to the
other repository.
The *modification timestamp* is part of the files metadata. It is available on
every relevant filesystem and is the natural indicator for a file change.
Modification timestamps do not require special action to create and have
a general meaning. One design goal of csync is to not require a special server
component, that’s why it was chosen as the backend component.
every relevant filesystem and is the typical indicator for a file change.
Modification timestamps do not require special action to create, and have a
general meaning. One design goal of csync is to not require a special server
component. This design goal is why csync was chosen as the backend component.
To compare the modification times of two files from different systems,
it is needed to operate on the same base. Before version 1.1.0,
csync requires both sides running on the exact same time, which can
be achieved through enterprise standard `NTP time synchronisation`_ on all
machines.
To compare the modification times of two files from different systems, csync
must operate on the same base. Before ownCloud Client version 1.1.0, csync
required both device repositories to run on the exact same time. This
requirement was achieved through the use of enterprise standard `NTP time
synchronisation`_ on all machines.
Since this strategy is rather fragile without NTP, ownCloud 4.5 introduced a
unique number, which changes whenever the file changes. Although it is a unique
value, it is not a hash of the file, but a randomly chosen number, which it will
transmit in the Etag_ field. Since the file number is guaranteed to change if
the file changes, it can now be used to determine if one of the files has
changed.
Because this timing strategy is rather fragile without the use of NTP, ownCloud
4.5 introduced a unique number (for each file?) that changes whenever the file
changes. Although this number is a unique value, it is not a hash of the file.
Instead, it is a randomly chosen number, that is transmitted in the Etag_
field. Because the file number changes if the file changes, its use is
guaranteed to determine if one of the files has changed and, thereby, launching
a synchronization process.
.. note:: ownCloud Client 1.1 and newer require file ID capabilities on the
ownCloud server, hence using them with a server earlier than 4.5.0 is
not supported.
.. note:: ownCloud Client release 1.1 and later requires file ID capabilities
on the ownCloud server. Servers that run with release earlier than 4.5.0 do
not support using the file ID functionality.
Before the 1.3.0 release of the client the sync process might create faux
conflict files if time deviates. The original and the conflict files only
differed in the timestamp, but not in content. This behaviour was changed
towards a binary check if the files are different.
Before the 1.3.0 release of the Desktop Client, the synchronization process
might create faux conflict files if time deviates. Original and changed files
conflict only in their timestamp, but not in their content. This behaviour was
changed to employ a binary check if files differ.
Just like files, directories also hold a unique id, which changes whenever
one of the contained files or directories gets modified. Since this is a
recursive process, it significantly reduces the effort required for a sync
cycle, because the client will only walk directories with a modified unique id.
Like files, directories also hold a unique ID that changes whenever one of the
contained files or directories is modified. Because this is a recursive
process, it significantly reduces the effort required for a synchronization
cycle, because the client only analyzes directories with a modified ID.
This table outlines the different sync methods attempted depending
on server/client combination:
The following table outlines the different synchronization methods used,
depending on server/client combination:
.. index:: compatiblity table
@ -98,10 +106,10 @@ on server/client combination:
| 4.5 or later | 1.1 or later | File ID, Time Stamp |
+--------------------+-------------------+----------------------------+
It is highly recommended to upgrade to ownCloud 4.5 or later with ownCloud
Client 1.1 or later, since the time stamp-based sync mechanism can
lead to data loss in certain edge-cases, especially when multiple clients
are involved and one of them is not in sync with NTP time.
We strongly recommend using ownCloud Server release 4.5 or later when using
ownCloud Client 1.1 or later. Using incompatible time stamp-based
synchronization mechanism can lead to data loss in rare cases, especially when
multiple clients are involved and one utilizes a non-synchronized NTP time.
.. _`NTP time synchronisation`: http://en.wikipedia.org/wiki/Network_Time_Protocol
.. _Etag: http://en.wikipedia.org/wiki/HTTP_ETag
@ -109,27 +117,28 @@ are involved and one of them is not in sync with NTP time.
Comparison and Conflict Cases
-----------------------------
In a sync run the client first has to detect if one of the two repositories have
changed files. On the local repository, the client traverses the file
tree and compares the modification time of each file with the value it was
before. The previous value is stored in the client's database. If it is not, it
means that the file has been added to the local repository. Note that on
the local side, the modificaton time a good attribute to detect changes because
it does not depend on time shifts and such.
As mentioned above, during a *sync run* the client must first detect if one of
the two repositories have changed files. On the local repository, the client
traverses the file tree and compares the modification time of each file with an
expected value stored in its database. If the value is not the same, the client
determines that the file has been modified in the local repository.
For the remote (ie. ownCloud) repository, the client compares the ETag of each
file with it's previous value. Again the previous value is queried from the
database. If the ETag is still the same, the file has not changed.
.. note:: On the local side, the modificaton time a good attribute to use for detecting changes, because
the value does not depend on time shifts and such.
In case a file has changed on both, the local and the remote repository since
the last sync run, it can not easily be decided which version of the file is
the one that should be used. However, changes to any side must not be lost.
For the remote (that is, ownCloud server) repository, the client compares the
ETag of each file with its expected value. Again, the expected ETag value is
queried from the client database. If the ETag is the same, the file has not
changed and no synchronization occurs.
That is called a **conflict case**. The client solves it by creating a conflict
file of the older of the two files and save the newer one under the original
file name. Conflict files are always created on the client and never on the
server. The conflict file has the same name as the original file appended with
the timestamp of the conflict detection.
In the event a file has changed on both the local and the remote repository
since the last sync run, it can not easily be decided which version of the file
is the one that should be used. However, changes to any side be lost. Instead,
a *conflict case* is created. The client resolves this conflic by creating a
conflict file of the older of the two files and saving the newer file under the
original file name. Conflict files are always created on the client and never
on the server. The conflict file uses the same name as the original file, but
is appended with the timestamp of the conflict detection.
.. _ignored-files-label:
@ -137,40 +146,40 @@ the timestamp of the conflict detection.
Ignored Files
-------------
ownCloud Client supports that certain files are excluded or ignored from
the synchronization. There are a couple of system wide file patterns which
come with the client. Custom patterns can be added by the user.
The ownCloud Client supports the ability to exclude or ignore certain files
from the synchronization process. Some system wide file patterns that are used
to exclude or ignore files are included with the client by default and the
ownCloud Client provides the ability to add custom patterns.
ownCloud Client will ignore the following files:
By default, the ownCloud Client ignores the following files:
* Files matched by one of the pattern in :ref:`ignoredFilesEditor-label`
* Files containing characters that do not work on certain file systems.
Currently, these characters are: `\, :, ?, *, ", >, <, |`
* Files starting in ``.csync_journal.db*`` (reserved for journalling)
- Files matched by one of the patterns defined in :ref:`ignoredFilesEditor-label`.
- Files containing characters that do not work on certain file systems (`\, :, ?, *, ", >, <, |`).
* Files starting in ``.csync_journal.db*``, as these files are reserved for journalling.
If a pattern is checkmarked in the `ignoredFilesEditor-label` (or if a line in
the exclude file starts with the character `]` directly followed
by the file pattern), files matching this pattern are considered fleeting
meta data. These files are ingored and *removed* by the client if found
in the sync folder. This is suitable for meta files created by some
If a pattern selected using a checkbox in the `ignoredFilesEditor-label` (or if
a line in the exclude file starts with the character `]` directly followed by
the file pattern), files matching the pattern are considered *fleeting meta
data*. These files are ingored and *removed* by the client if found in the
synchronized folder. This is suitable for meta files created by some
applications that have no sustainable meaning.
If a pattern is ending with character `/` it means that only directories are
matched. The pattern is only applied for directory components of the checked
filename.
If a pattern ends with the backslash (`/`) character, only directories are
matched. The pattern is only applied for directory components of filenames
selected using the checkbox.
To match file names against the exclude patterns, the unix standard C
library function fnmatch is used. It checks the filename against the pattern
using standard shell wildcard pattern matching. Check `The opengroup website
<http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_01>`
for the gory details.
To match filenames against the exclude patterns, the unix standard C library
function fnmatch is used. This procesx checks the filename against the
specified pattern using standard shell wildcard pattern matching. For more
information, please refer to `The opengroup website
<http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_01>`.
The path that is checked is the relative path unter the sync root directory.
The path that is checked is the relative path under the sync root directory.
**Pattern and File Match Examples:**
Examples:
^^^^^^^^^
+-----------+------------------------------+
| Pattern | Matches |
| Pattern | File Matches |
+===========+==============================+
| ``~$*`` | ``~$foo``, ``~$example.doc`` |
+-----------+------------------------------+
@ -183,15 +192,17 @@ Examples:
The Sync Journal
----------------
The client stores the ETag number in a per-directory database,
called the journal. It is a hidden file right in the directory
to be synced.
The client stores the ETag number in a per-directory database, called the
*journal*. This database is a hidden file contained in the directory to be
synchronized.
If the journal database gets removed, ownCloud Client's CSync backend will
rebuild the database by comparing the files and their modification times. Thus
it should be made sure that both server and client synchronized with NTP time
before restarting the client after a database removal.
If the journal database is removed, the ownCloud Client CSync backend rebuilds
the database by comparing the files and their modification times. This process
ensures that both server and client are synchronized using the appropriate NTP
time before restarting the client following a database removal.
Pressing ``F5`` in the Account Settings Dialog that allows to "reset" the
journal. That can be used to recreate the journal database. Use this only
if advised to do so by the developer or support staff.
Pressing ``F5`` while in the Account Settings Dialog enables you to "reset" the
journal. This function can be used to recreate the journal database.
.. note:: We recommend that you use this function only when advised to do so by
ownCloud support staff.

139
doc/autoupdate.rst
View file

@ -1,81 +1,126 @@
The Automatic Updater
=====================
To ensure you're always using the latest version of ownCloud Client, an
auto-update mechanism has been added in Version 1.5.1. It will ensure
that will automatically profit from the latest features and bugfixes.
To ensure that you are always using the latest version of the ownCloud client,
an auto-update mechanism has been added in Version 1.5.1. The Automatic Updater
ensures that you automatically profit from the latest features and bugfixes.
The updater works differently depending on the operating system.
.. note:: The Automatic Updater functions differently, depending on the operating system.
Basic Workflow
--------------
The following sections describe how to use the Automatic Updater on different operating systems:
Windows
^^^^^^^
ownCloud client will check for updates and download the update if one
is available. You can view the status under ``Settings -> General -> Updates``.
If an update is available and has been successfully downloaded, ownCloud
Client will start a silent update prior to its next launch and then start itself.
If the silent update fails, the client offers a manual download.
The ownCloud client checks for updates and downloads them when available. You
can view the update status under ``Settings -> General -> Updates`` in the
ownCloud client.
.. note:: The user needs to be able to attain administrative privileges
to successfully perform the update.
If an update is available, and has been successfully downloaded, the ownCloud
client starts a silent update prior to its next launch and then restarts
itself. Should the silent update fail, the client offers a manual download.
.. note:: Administrative privileges are required to perform the update.
Mac OS X
^^^^^^^^
If a new update is available, ownCloud client will ask the user to update
to the latest version using a pop-up dialog. This is the default for Mac
OS X applications which use the Sparkle framework.
If a new update is available, the ownCloud 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.
Linux
^^^^^
Since distributions provide their own update tool, ownCloud Client on Linux
will not perform any updates on its own. It will, however, check for the
latest version and passively notify the user (``Settings -> General -> Updates``)
if an update is available.
Linux distributions provide their own update tool, so ownCloud clients that use
the Linux operating system do not perform any updates on their own. Linux
operating systems do, however, check for the latest version of the ownCloud
client and passively notify the user (``Settings -> General -> Updates``) when
an update is available.
Preventing Auto Updates
-----------------------
Preventing Automatic Updates
----------------------------
In controlled environment such as companies or universities, the auto-update
mechanism might not be desired as it interferes with controlled deployment
tools and policies. In this case, it is possible to disable the auto-updater
entirely:
In controlled environments, such as companies or universities, you might not
want to enable the auto-update mechanism, as it interferes with controlled
deployment tools and policies. To address this case, it is possible to disable
the auto-updater entirely. The following sections describe how to disable the
auto-update mechanism for different operating systems.
Windows
^^^^^^^
Preventing Automatic Updates in Windows Environents
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There are two alternative approaches:
You can prevent automatic updates from occuring in Windows environments 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.
1. In ``HKEY_LOCAL_MACHINE\Software\ownCloud\ownCloud``, add a key ``skipUpdateCheck`` (of type DWORD) with the value 1 to the machine. This key
can be manually overrideen by the same value in ``HKEY_CURRENT_USER``.
To prevent automatic updates, but allow manual overrides:
2. In ``HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud``, add a key
``skipUpdateCheck`` (of type DWORD) with the value 1 to the machine.
Setting the value here cannot be overridden by the user and is the preferred
way to control the updater behavior via Group Policies.
1. Migrate to the following directory::
Mac OS X
^^^^^^^^
HKEY_LOCAL_MACHINE\Software\ownCloud\ownCloud
You can disable the update check via a system-wide ``.plist`` file located
at ``/Library/Preferences/com.owncloud.desktopclient.plist``. Add a new root
level item of type bool and the name ``skipUpdateCheck`` and set it to ``true``.
You can also just copy the file
``owncloud.app/Contents/Resources/deny_autoupdate_com.owncloud.desktopclient.plist```
2. Add the key ``skipUpdateCheck`` (of type DWORD).
3. Specify a value of ``1`` to the machine.
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 Group Policies.
1. Migrate to the following directory::
HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud
2. Add the key ``skipUpdateCheck`` (of type DWORD).
3. Specify a value of ``1`` to the machine.
Preventing Automatic Updates in Mac OS X Environments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can disable the automatic update mechanism in MAC OS X operating systems
using the system-wide ``.plist`` file. To access this file:
1. Using the Windows explorer, migrate to the following location::
/Library/Preferences/
2. Locate and open the following file::
com.owncloud.desktopclient.plist
3. Add a new root level item of type ``bool``.
4. Name the item ``skipUpdateCheck``.
5. Set the item to ``true``.
Alternatively, you can copy the file
``owncloud.app/Contents/Resources/deny_autoupdate_com.owncloud.desktopclient.plist``
to ``/Library/Preferences/com.owncloud.desktopclient.plist``.
Linux
^^^^^
Preventing Automatic Updates in Linux Environments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Since there is no updating functionality, there is no need to remove the check.
If you want to disable the check nontheless, open a file called
``/etc/ownCloud/ownCloud.conf`` and add the following content::
Because Linux does not provide automatic updating functionality, there is no
need to remove the automatic-update check. However, if you want to disable
this check:
[General]
skipUpdateCheck=true
1. Locate and open the following file::
/etc/ownCloud/ownCloud.conf
2. Add the following content to the file::
[General]
skipUpdateCheck=true

160
doc/building.rst
View file

@ -3,20 +3,20 @@
Appendix A: Building the Client
===============================
This section explains how to build the ownCloud Client from source
for all major platforms. You should read this section if you want
to development on the desktop client.
This section explains how to build the ownCloud Client from source for all
major platforms. You should read this section if you want to develop for the
desktop client.
Note that the building instruction are subject to change as development
proceeds. It is important to check the version which is to built.
.. note:: Building instruction are subject to change as development proceeds.
Please check the version for which you want to built.
This instructions were updated to work with ownCloud Client 1.5.
The instructions contained in this topic were updated to work with version 1.5 of the ownCloud Client.
Linux
-----
1. Add the `ownCloud repository from OBS`_.
2. Install the dependencies (as root, or via sudo):
2. Install the dependencies (as root, or using ``sudo``) using the following commands for your specific Linux distribution:
* Debian/Ubuntu: ``apt-get update; apt-get build-dep owncloud-client``
* openSUSE: ``zypper ref; zypper si -d owncloud-client``
@ -27,47 +27,51 @@ Linux
Mac OS X
--------
Next to XCode (and the command line tools!), you will need some
extra dependencies.
In additon to needing XCode (along with the command line tools), developing in
the MAC OS X 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.
You can install these dependencies via MacPorts_ or Homebrew_.
This is only needed on the build machine, since non-standard libs
will be deployed in the app bundle.
The tested and preferred way to develop in this environment is through the use
of HomeBrew_. The ownCloud team has its own repository containing non-standard
recipes.
The tested and preferred way is to use HomeBrew_. The ownCloud team has
its own repository which contains non-standard recipes. Add it with::
To set up your build enviroment for development using HomeBrew_:
1. Add the ownCloud repository using the following command::
brew tap owncloud/owncloud
Next, install the missing dependencies::
2. Install any missing dependencies::
brew install $(brew deps mirall)
To build mirall, follow the `generic build instructions`_.
.. note::
You should not call ``make install`` at any time, since the product of the
mirall build is an app bundle. Call ``make package`` instead to create an
install-ready disk image.
.. note:: Because the product from the mirall build is an app bundle, do not
call ``make install`` at any time. Instead, call ``make package`` to create an
install-ready disk image.
Windows (cross-compile)
Windows (Cross-Compile)
-----------------------
Due to the amount of dependencies, building the client for Windows
is **currently only supported on openSUSE**, by using the MinGW
cross compiler. You can set up openSUSE 12.1, 12.2 or 13.1 in a virtual machine
if you do not have it installed already.
Due to the large number of dependencies, building the client for Windows is
**currently only supported on openSUSE**, by using the MinGW cross compiler.
You can set up openSUSE 12.1, 12.2, or 13.1 in a virtual machine if you do not
have it installed already.
In order to cross-compile, the following repositories need to be added
via YaST or ``zypper ar`` (adjust when using openSUSE 12.2 or 13.1)::
To cross-compile:
zypper ar http://download.opensuse.org/repositories/windows:/mingw:/win32/openSUSE_13.1/windows:mingw:win32.repo
zypper ar http://download.opensuse.org/repositories/windows:/mingw/openSUSE_13.1/windows:mingw.repo
1. Add the following repositories using YaST or ``zypper ar`` (adjust when using openSUSE 12.2 or 13.1):
Next, install the cross-compiler packages and the cross-compiled dependencies::
- ``zypper ar http://download.opensuse.org/repositories/windows:/mingw:/win32/openSUSE_13.1/windows:mingw:win32.repo``
zypper install cmake make mingw32-cross-binutils mingw32-cross-cpp mingw32-cross-gcc \
- ``zypper ar http://download.opensuse.org/repositories/windows:/mingw/openSUSE_13.1/windows:mingw.repo``
2. Install the cross-compiler packages and the cross-compiled dependencies::
``zypper install cmake make mingw32-cross-binutils mingw32-cross-cpp mingw32-cross-gcc \
mingw32-cross-gcc-c++ mingw32-cross-pkg-config mingw32-filesystem \
mingw32-headers mingw32-runtime site-config mingw32-libqt4-sql \
mingw32-libqt4-sql-sqlite mingw32-sqlite mingw32-libsqlite-devel \
@ -78,74 +82,86 @@ Next, install the cross-compiler packages and the cross-compiled dependencies::
mingw32-libpng-devel mingw32-libsqlite mingw32-qtkeychain \
mingw32-qtkeychain-devel mingw32-dlfcn mingw32-libintl-devel \
mingw32-libneon-devel mingw32-libopenssl-devel mingw32-libproxy-devel \
mingw32-libxml2-devel mingw32-zlib-devel
mingw32-libxml2-devel mingw32-zlib-devel``
For the installer, the NSIS installer package is also required::
3. For the installer, install the NSIS installer package::
zypper install mingw32-cross-nsis
``zypper install mingw32-cross-nsis``
.. Usually, the following would be needed as well, but due to a bug in mingw, they
will currently not build properly from source.
4. Install the following plugin::
mingw32-cross-nsis-plugin-processes mingw32-cross-nsis-plugin-uac
``mingw32-cross-nsis-plugin-processes mingw32-cross-nsis-plugin-uac``
You will also need to manually download and install the following files with
``rpm -ivh <package>`` (They will also work with openSUSE 12.2 and newer)::
.. note:: This plugin is typically required. However, due to a current bug
in ``mingw``, the plugins do not currently build properly from source.
rpm -ihv http://download.tomahawk-player.org/packman/mingw:32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-processes-0-1.1.x86_64.rpm
rpm -ihv http://download.tomahawk-player.org/packman/mingw:32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-uac-0-3.1.x86_64.rpm
5. Manually download and install the following files using ``rpm -ivh <package>``:
Now, follow the `generic build instructions`_, but pay attention to
the following differences:
..note:: These files operate using openSUSE 12.2 and newer.
For building for windows a special toolchain file has to be specified.
That makes cmake finding the platform specific tools. This parameter
has to be added to the call to cmake:
- ``rpm -ihv http://download.tomahawk-player.org/packman/mingw:32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-processes-0-1.1.x86_64.rpm``
``-DCMAKE_TOOLCHAIN_FILE=../mirall/admin/win/Toolchain-mingw32-openSUSE.cmake``
- ``rpm -ihv http://download.tomahawk-player.org/packman/mingw:32/openSUSE_12.1/x86_64/mingw32-cross-nsis-plugin-uac-0-3.1.x86_64.rpm``
Finally, just build by running ``make``. ``make package`` will produce
an NSIS-based installer, provided the NSIS mingw32 packages are installed.
6. Follow the `generic build instructions`_
.. note:: When building for Windows platforms, you must specify a special
toolchain file that enables cmake to locate the platform-specific tools. To add
this parameter to the call to cmake, enter
``DCMAKE_TOOLCHAIN_FILE=../mirall/admin/win/Toolchain-mingw32-openSUSE.cmake``.
7. Build by running ``make``.
..note:: Using ``make package`` produces an NSIS-based installer, provided
the NSIS mingw32 packages are installed.
Generic Build Instructions
--------------------------
.. _`generic build instructions`
Compared to previous versions building of Mirall has become more easy.
CSync, which is the sync engine library of Mirall, is now part of the
Mirall source repository, not, like it was before, a separate module.
Compared to previous versions, building Mirall has become easier. Unlike
earlier versions, CSync, which is the sync engine library of Mirall, is now
part of the Mirall source repository and not a separate module.
Mirall can be downloaded at ownCloud's `Client Download Page`_.
You can download Mirall from the ownCloud `Client Download Page`_.
If you want to build the leading edge version of the client, you should
use the latest versions of Mirall via Git_, like so::
To build the most up to date version of the client:
git clone git://github.com/owncloud/mirall.git
1. Clone the latest versions of Mirall from Git_ as follows:
Next, create build directories::
``git clone git://github.com/owncloud/mirall.git``
mkdir mirall-build
2. Create build directories:
Now build mirall::
``mkdir mirall-build``
cd ../mirall-build
cmake -DCMAKE_BUILD_TYPE="Debug" ../mirall
3. Build mirall:
Note that it is important to use absolute pathes for the include- and library
directories. If this succeeds, call ``make``. The owncloud binary should appear
in the ``bin`` directory. You can also run ``make install`` to install the client to
``/usr/local/bin``.
``cd ../mirall-build``
``cmake -DCMAKE_BUILD_TYPE="Debug" ../mirall``
To build an installer/app bundle (requires the mingw32-cross-nsis packages on Windows)::
..note:: You must use absolute pathes for the ``include`` and ``library`` directories.
make package
4. Call ``make``.
Known cmake parameters:
The owncloud binary appear in the ``bin`` directory.
* QTKEYCHAIN_LIBRARY=/path/to/qtkeychain.dylib -DQTKEYCHAIN_INCLUDE_DIR=/path/to/qtkeychain/: Use QtKeychain for stored credentials. When compiling with Qt5, the library is called qt5keychain.dylib. You need to compile QtKeychain with the same Qt version.
* WITH_DOC=TRUE: create doc and manpages via running ``make``; also adds install statements to be able to install it via ``make install``.
* CMAKE_PREFIX_PATH=/path/to/Qt5.2.0/5.2.0/yourarch/lib/cmake/ : to build with Qt5
* BUILD_WITH_QT4=ON : to build with Qt4 even if Qt5 is found
5. (Optional) Call ``make install`` to install the client to the ``/usr/local/bin`` directory.
6. (Optional) Call ``make package`` to build an installer/app bundle
..note:: This step requires the ``mingw32-cross-nsis`` packages be installed on Windows.
The following are known cmake parameters:
* ``QTKEYCHAIN_LIBRARY=/path/to/qtkeychain.dylib -DQTKEYCHAIN_INCLUDE_DIR=/path/to/qtkeychain/``:
Used for stored credentials. When compiling with Qt5, the library is called ``qt5keychain.dylib.``
You need to compile QtKeychain with the same Qt version.
* ``WITH_DOC=TRUE``: Creates doc and manpages through running ``make``; also
* adds install statements, providing the ability to install using ``make
* install``.
* ``CMAKE_PREFIX_PATH=/path/to/Qt5.2.0/5.2.0/yourarch/lib/cmake/``: Builds using Qt5.
* ``BUILD_WITH_QT4=ON``: Builds using Qt4 (even if Qt5 is found).
.. _`ownCloud repository from OBS`: http://software.opensuse.org/download/package?project=isv:ownCloud:devel&package=owncloud-client
.. _CSync: http://www.csync.org

24
doc/conffile.rst
View file

@ -1,26 +1,24 @@
ownCloud Client reads a configuration file.
The ownCloud Client reads a configuration file. You can locate this configuration files as follows:
On Linux it can be found in:
- On Linux distributions:
``$HOME/.local/share/data/ownCloud/owncloud.cfg``
On Windows it can be found in:
- In Microsoft Windows systems:
``%LOCALAPPDATA%\ownCloud\owncloud.cfg``
On Mac it can be found in:
- In MAC OS X systems:
``$HOME/Library/Application Support/ownCloud``
It contains settings in the ini file format known from Windows.
The configuration file contains settings using the Microsoft Windows .ini file
format. You can overwrite changes using the ownCloud configuration dialog.
.. note:: Changes here should be done carefully as wrong settings can cause disfunctionality.
.. note:: Use caution when making changes to the ownCloud Client configuration
file. Incorrect settings can produce unintended results.
.. note:: Changes may be overwritten by using ownCloud's configuration dialog.
You can change the following configuration settings:
These are config settings that may be changed:
- ``remotePollInterval`` (default: ``30000``) -- Specifies the poll time for the remote repository in milliseconds.
``remotePollInterval`` (default: ``30000``)
Poll time for the remote repository in milliseconds
``maxLogLines`` (default: ``20000``)
Maximum count of log lines shown in the log window
- ``maxLogLines`` (default: ``20000``) -- Specifies the maximum number of log lines displayed in the log window.

19
doc/faq.rst
View file

@ -1,16 +1,17 @@
FAQ
===
Some files are continuously uploaded to the server even when they are not modified
----------------------------------------------------------------------------------
**Issue:**
Some files are continuously uploaded to the server, even when they are not modified.
**Resolution:**
It is possible that another program is changing the modification date of the file.
If the file is a ``.eml`` file, Windows automatically change all file all the time unless you remove
``\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\PropertySystem\PropertyHandlers`` from
the windows registry.
See http://petersteier.wordpress.com/2011/10/22/windows-indexer-changes-modification-dates-of-eml-files/
If the file is uses the ``.eml`` extention, Windows automatically and
continually changes all files, unless you remove
``\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\PropertySystem\PropertyHandlers`
from the windows registry.
See http://petersteier.wordpress.com/2011/10/22/windows-indexer-changes-modification-dates-of-eml-files/ for more information.

BIN
doc/images/client_setup_wizard_components.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
doc/images/client_setup_wizard_install_finish.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
doc/images/client_setup_wizard_install_progress.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
doc/images/client_setup_wizard_location.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
doc/images/client_setup_wizard_main.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
doc/images/client_setup_wizard_reinstall.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/images/client_setup_wizard_uninstall.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/images/client_setup_wizard_uninstall_2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
doc/images/client_setup_wizard_uninstall_3.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
doc/images/download_button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
doc/images/log_output_window.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 43 KiB

BIN
doc/images/oc_client_download_options.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7 KiB

BIN
doc/images/oc_client_linux_download.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
doc/images/oc_client_macosx_download.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/images/oc_client_windows_download.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
doc/images/oc_client_windows_option.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.6 KiB

BIN
doc/images/oc_connection_wizard_credentials.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
doc/images/oc_connection_wizard_finish.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 40 KiB

BIN
doc/images/oc_connection_wizard_localfolder.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 36 KiB

BIN
doc/images/oc_connection_wizard_server.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
doc/images/oc_website.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 71 KiB

BIN
doc/images/owncloud_logo_transparent.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 46 KiB

BIN
doc/images/owncloud_small_wh_bl.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/images/save_log_file.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 66 KiB

BIN
doc/images/security_warning_windows.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

5
doc/index.rst
View file

@ -4,11 +4,12 @@ Contents
========
.. toctree::
:maxdepth: 2
:maxdepth: 3
introduction
installing
accountsetup
visualtour
navigating
advancedusage
autoupdate

208
doc/installing-linux.rst Normal file
View file

@ -0,0 +1,208 @@
.. _installing-linux:
Installing the Linux Desktop Client
===================================
The ownCloud Desktop Client is provided for a wide range of Linux
distributions. The following table provides a list of Linux operating systems
and the specific distributions on which you can install the Desktop Client.
+------------------+-------------------------+
| Operating System | Distribution |
+==================+=========================+
| CentOS (Redhat) | - Red Hat RHEL-6 |
| | - CentOS CentOS-6 |
+------------------+-------------------------+
| Debian | - Debian 7.0 |
| | - Fedora 19 |
| | - Fedora 20 |
+------------------+-------------------------+
| openSUSE | - openSUSE |
| | - Factory PPC |
| | - openSUSE Factory ARM |
| | - openSUSE Factory |
| | - openSUSE 13.1 Ports |
| | - openSUSE 13.1 |
| | - openSUSE 12.3 Ports |
| | - openSUSE 12.3 |
| | - openSUSE 12.2 |
+------------------+-------------------------+
| SUSE (SLE) | - SLE 11 SP3 |
+------------------+-------------------------+
| Ubuntu | - xUbuntu 14.04 |
| | - xUbuntu 13.10 |
| | - xUbuntu 12.10 |
| | - xUbuntu 12.04 |
+------------------+-------------------------+
General instructions for how to install the ownCloud Desktop Client on any
supported Linux distribution can be found on the `ownCloud download page
<http://software.opensuse.org/download/package?project=isv:ownCloud:desktop&package=owncloud-client>`_.
Linux Installation Methods
--------------------------
You can install the ownCloud Desktop Client using either of the following three methods:
- One Click Install (openSUSE and SUSE SLE distributions only) — Installs the
ownCloud Desktop using a bundled installation package.
- Adding the ownCloud package repository — Installs the ownCloud Desktop client
using a Linux terminal and keeps it up to date using the distribution's
package manager.
.. note::
Manual command line installation requires that you perform the installation as root.
- Binary package — Installs the ownCloud Desktop Client using a raw binary package.
Installing the Desktop Client on Redhat or CentOS Linux Operating Systems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install the ownCloud Desktop Client on a Redhat or CentOS operating system manually:
1. Open a Linux terminal window.
2. Specify the directory in which you want to install the client.
``cd /etc/yum.repos.d/``
3. Choose and download the client for your specific distribution:
* Red Hat RHEL-6: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/RedHat_RHEL-6/isv:ownCloud:desktop.repo``
* CentOS CentOS-6: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/CentOS_CentOS-6/isv:ownCloud:desktop.repo``
4. Install the client.
``yum install owncloud-client``
5. After the installation completes, go to Setting Up the ownCloud Desktop Client.
**Installing the Desktop Client on Debian 7.0 Linux Operating Systems Manually**
To install the ownCloud Desktop Client on the Debian 7.0 distribution manually:
1. Open a Linux terminal window.
2. Download the client.
``echo 'deb http://download.opensuse.org/repositories/isv:/ownCloud:/desktop/Debian_7.0/ /' >> /etc/apt/sources.list.d/owncloud-client.list``
3. Download the package lists from any repositories and updates them to ensure the latest package versions and their dependencies.
``apt-get update``
4. Install the client.
``apt-get install owncloud-client``
5. (Optional) Download the apt-key for the Debian repository
``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/Debian_7.0/Release.key``
6. After the installation completes, go to Setting Up the ownCloud Desktop Client.
Installing the Desktop Client on Fedora Linux Operating Systems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install the ownCloud Desktop Client on the Fedora operating system manually:
1. Open a Linux terminal window.
2. Specify the directory in which you want to install the client.
cd /etc/yum.repos.d/
3. Choose and download the client for your specific distribution
* Fedora 19: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/Fedora_19/isv:ownCloud:desktop.repo``
* Fedora 20: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/Fedora_20/isv:ownCloud:desktop.repo``
4. Install the client.
``yum install owncloud-client``
5. After the installation completes, go to Setting Up the ownCloud Desktop Client.
Installing the Desktop Client on openSUSE Linux Operating Systems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install the ownCloud Desktop Client on the openSUSE operating system manually:
1. Open a Linux terminal window.
2. Choose and download the client for your specific distribution:
* Factory PPC: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_Factory_PPC/isv:ownCloud:desktop.repo``
* **Factory ARM**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_Factory_ARM/isv:ownCloud:desktop.repo``
* **Factory**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_Factory/isv:ownCloud:desktop.repo``
* **13.1 Ports**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_13.1_Ports/isv:ownCloud:desktop.repo``
* **13.1**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_13.1/isv:ownCloud:desktop.repo``
* **12.3 Ports**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_12.3_Ports/isv:ownCloud:desktop.repo``
* **12.3**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_12.3/isv:ownCloud:desktop.repo``
* **12.2**: ``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/openSUSE_12.2/isv:ownCloud:desktop.repo``
3. Download any package metadata from the medium and store it in local cache.
``zypper refresh``
4. Install the client.
``zypper install owncloud-client``
5. After the installation completes, go to Setting Up the ownCloud Desktop Client.
Installing the Desktop Client on SLE Linux Operating Systems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install the ownCloud Desktop Client on the SUSE Linux Enterprise (SLE) operating system.
1. Open a Linux terminal window.
2. Download the client.
``zypper addrepo http://download.opensuse.org/repositories/isv:ownCloud:desktop/SLE_11_SP3/isv:ownCloud:desktop.repo``
3. Download any package metadata from the medium and store it in local cache.
``zypper refresh``
4. Install the client.
``zypper install owncloud-client``
5. After the installation completes, go to Setting Up the ownCloud Desktop Client.
Installing the Desktop Client on Ubuntu Linux Operating Systems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To install the ownCloud Desktop Client on the Ubuntu operating system:
1. Open a Linux terminal window.
2. Choose and download the client for your specific distribution:
* **xUbuntu 14.04**: ``sudo sh -c "echo 'deb http://download.opensuse.org/repositories/isv:/ownCloud:/desktop/xUbuntu_14.04/ /' >> /etc/apt/sources.list.d/owncloud-client.list"``
* **xUbuntu 13.10**: ``sudo sh -c "echo 'deb http://download.opensuse.org/repositories/isv:/ownCloud:/desktop/xUbuntu_13.10/ /' >> /etc/apt/sources.list.d/owncloud-client.list"``
* **xUbuntu 12.10**: ``sudo sh -c "echo 'deb http://download.opensuse.org/repositories/isv:/ownCloud:/desktop/xUbuntu_12.10/ /' >> /etc/apt/sources.list.d/owncloud-client.list"``
* **xUbuntu 12.04**: ``sudo sh -c "echo 'deb http://download.opensuse.org/repositories/isv:/ownCloud:/desktop/xUbuntu_12.04/ /' >> /etc/apt/sources.list.d/owncloud-client.list"``
3. Download the package lists from any repositories and updates them to ensure the latest package versions and their dependencies.
``apt-get update``
4. Install the client.
``sudo apt-get install owncloud-client``
5. (Optional) Download the apt-key for the Ubuntu repository:
* **xUbuntu 14.04**: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/xUbuntu_14.04/Release.key``
* **xUbuntu 13.10**: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/xUbuntu_13.10/Release.key``
* **xUbuntu 12.10**: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/xUbuntu_12.10/Release.key``
* **xUbuntu 12.04**: ``wget http://download.opensuse.org/repositories/isv:ownCloud:desktop/xUbuntu_12.04/Release.key``
6. (Optional) Add the apt key.
``sudo apt-key add - < Release.key``
7. After the installation completes, go to `Setting Up the ownCloud Desktop Client`_.

4
doc/installing-macosx.rst Normal file
View file

@ -0,0 +1,4 @@
.. _installing-macosx:
Installing the MAC OSX Desktop Client
=====================================

102
doc/installing-windows.rst Normal file
View file

@ -0,0 +1,102 @@
.. _installing-windows:
Installing the Windows Desktop Client
=====================================
The ownCloud desktop client for Windows is provided as a Nullsoft Scriptable Install System (NSIS) setup file for machine-wide installation.
To install the ownCloud desktop client:
1. Access the ownCloud website.
The ownCloud web page opens.
.. image:: images/oc_website.png
ownCloud Web Page
2. Select Products > Desktop Clients from the website menu.
The Desktop Client download page opens.
.. image:: images/oc_client_download_options.png
Desktop client download selections
3. Click the 'Download for Windows' option.
The Desktop Client download page opens.
.. image:: images/oc_client_windows_download.png
ownCloud Windows Client Download
4. Click the 'download' button.
The Microsoft Windows client download begins. Depending on your browser
settings, the client installation file might launch automatically.
5. Once the download completes, locate the client installation file in your system Downloads folder.
6. Double-click the client installation file to start the download.
The Open File - Security Warning dialog box opens.
.. image:: images/security_warning_windows.png
Open File - Security Warning dialog box
7. Click 'Run' in the dialog box to begin the installation.
On systems running virus protection software, you might have to verify
that you want to install the ownCloud Desktop Client software.
8. Click 'Yes' to continue with the software installation.
The ownCloud Setup Wizard window opens.
.. image:: images/client_setup_wizard_main.png
ownCloud Setup Wizard Window
9. Click 'Next' to continue.
The Choose Components window opens.
.. image:: images/client_setup_wizard_components.png
Choose Components Window
10. Choose the components that you want to install for the Desktop Client.
All relevant components for your platform are selected by default.
However, you can choose to exlude different components from the installation.
11. Click Next to continue.
The Choose Install Location window opens.
.. image:: images/client_setup_wizard_location.png
Choose Install Location window
12. Verify the destination folder for the Desktop Client installation and then click Install.
The Installing window opens.
.. image:: images/client_setup_wizard_install_progress.png
Installing window
13. Once the installation completes, click 'Next' to continue.
The Setup Wizard Completion window opens.
.. image:: images/client_setup_wizard_install_finish.png
Completion window
You can choose to launch the Desktop Client from this window or launch the application at another time.
14. Click 'Finish' to complete the installation.
After the installation completes, go to Setting Up the ownCloud Desktop Client.

13
doc/installing.rst Normal file
View file

@ -0,0 +1,13 @@
Installing the Synchronization Client
=====================================
The latest version of the ownCloud Synchronization Client can be obtained from
the `ownCloud Website <http://www.owncloud.com>`_. You can download and install
the client on Windows, MAC OSX, and various Linux software distrubutions. The
following sections describe specific support and installation procedures for
the different software platforms:
- :ref:`installing-windows`
- :ref:`installing-macosx`
- :ref:`installing-linux`

34
doc/introduction.rst
View file

@ -1,32 +1,14 @@
Introduction
============
The ownCloud Sync Client is a desktop program installed on a user’s computer.
It allows a user to specify one or more directories on the local machine to
sync to the ownCloud server. It allows the user to always have the latest
files wherever they may be. When a change is made to the file on the
computer, it will sync to the ownCloud server via the sync client.
Available for Windows, MAC OS X, and various Linux distributions, the ownCloud
Sync client is a desktop program installed on your computer. The client enables
you to:
The ownCloud Sync Client is available for Windows, MAC OS X, and various
Linux distributions.
- Specify one or more directories on your computer that you want to synchronize
to the ownCloud server.
- Always have the latest files synchronized, wherever they are located.
Obtaining the Client
--------------------
Changes made to any synchronized file on the computer are automatically made to
the files on the ownCloud server using the sync client.
The latest version of the Client can be obtained on the ownCloud web site.
ownCloud client for **Windows** is provided as a NSIS-based setup file for
machine-wide install. Installing the ownCloud client on **Mac OS** follows
the normal app bundle installation pattern:
1. Download the installation file: Click ``ownCloud-x.y.z.dmg``, a window with
the ownCloud icon opens.
2. In that window, drag the ownCloud application into the ``Applications``
folder.
3. On the right hand side From ``Applications``, choose ``ownCloud``.
The ownCloud client is also provided as in a convenient repository for a wide
range of popular **Linux distributions**.
Supported distributions are Fedora, openSUSE, Ubuntu and Debian.
To support other distributions, a is required, see :ref:`building-label`

BIN
doc/logo-blue.pdf
View file

Binary file not shown.

313
doc/navigating.rst Normal file
View file

@ -0,0 +1,313 @@
Using the Synchronization Client
================================
.. index:: navigating, usage
The ownCloud 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).
.. image:: images/icon.png
**ownCloud Desktop Client icon**
Using the Desktop Client Menu
-----------------------------
A right click on the icon (left click on Ubuntu and Mac OS X) provides the
following menu:
.. image:: images/menu.png
**ownCloud Desktop Client menu**
The Desktop Client menu provides the following options:
* ``Open ownCloud in browser``: Launches the ownCloud WEB interface.
* ``Open folder 'ownCloud'``: Opens the ownCloud local folder. If you have defined multiple synchronization targets, the window displays each local folder.
* **Disk space indicator**: Indicates the amount of space currently used on the server.
* Operation indicator: Displays the status of the current synchronization process or indicates ``Up to date`` if the server and client are in sync.
* **Recent Changes**: Displays the last six files modified by the synchronization operations and provides access to the current synchronization status listing all changes since the last restart of the ownCloud client.
* ``Settings...``: Provides access to the settings menu.
* ``Help``: Opens a browser to display ownCloud Desktop Client Guide.
* ``Sign out``: Disables the client from continued synchronizations.
* ``Quit ownCloud``: Quits the ownCloud Client, ending any currently running
synchronizations.
Using the Account Settings Window
---------------------------------
.. index:: account settings, user, password, Server URL
The ``Account`` window provides a summary for general settings associated with the ownCloud account. This window enalbes you to manage any synchronized folders in the account and enables you to modify them.
To access and modify the account settings:
.. image:: images/settings_account.png
:scale: 50 %
The fields and options in this window include:
* ``Connected to <ownCloud instance> as <user>`` field: Indicates the ownCloud server to which the client is synchronizing and the user account on that server.
* ``Add Folder...`` button: Provides the ability to add another folder to the synchronization process (see ``Adding a Folder``).
* ``Pause/Resume`` button: Pauses the current sync (or prevents the client from starting a new sync) or resumes the sync process.
* ``Remove`` button: Removes the selected folder from the sync process. This button is used when you want to synchronize only a few folders and not the root folder. If only the root folder is available, you must first remove the root from the synchronization and then add individual folders that you want to synchronize as desired.
* ``Storage Usage`` field: Indicates the storage utilization on the ownCloud server.
* ``Edit Ignored Files`` button: Launches the Ignored Files Editor.
* ``Modify Account`` button: Enables you to change the ownCloud server to which you are synchronizing. This option launches the ``Setting up an Account`` windows (See ??).
Adding a Folder
^^^^^^^^^^^^^^^
The ``Add a Folder ...`` button enables you to add a new folder to the syncrhonization process.
To add a new folder:
1. Click the ``Add a Folder ...`` button in the Account window.
The ``Add Folder...`` window opens
.. image:: images/folderwizard_local.png
:scale: 50 %
**``Add Folder...`` window (local folder)**
2. Specify a *unique* path and alias name to the folder or use the ``Choose...`` button to locate the new folder on your system to which you want to synchronize.
..note:: Nested synchronizations are not supported. In other words, you
cannot add a folder that is already contained within another synchronized
folder. In addition, you cannot add a higher level (parent) folder that
contains a folder to which you are already synchronizing. By default, the
ownCloud Set Up Wizard syncrhonizes your entire ownCloud account to the root
folder of the ownCloud server. Due to this default setup, you must first remove
the top-level folder prior to specifying new synchronizations.
3. Click 'Next' to continue.
A window opens prompting you to select a remote destination folder on the
ownCloud server to which you want to synchronize.
.. image:: images/folderwizard_remote.png
:scale: 50 %
**``Add Folder...`` window (remote destination)**
4. Select a folder on the ownCloud server to which you want to synchronize your newly added folder.
..note:: A server folder can only be synchronized with a particular client once.
If you attempt to sync the root directory, you cannot sync with other folders
on the server. Similarly, if you sync with folder ``/a``, you cannot create
another sync with ``/a/b``, since ``b`` is already being synched.
Editing Ignored Files
^^^^^^^^^^^^^^^^^^^^^
The :guilabel:`Ignored Files Editor` provides a list of preconfigured files
that are ignored (that is, not synchronized) by the client and server during
synchronizations. The Ignored Files Editor enables you to add patterns for
files or directories that you want to exclude from the synchronization process.
In addition to using standard characters, the Ignored Files Editor enables you
to use wild cards (for example, using an asterisk ‘*’ to indicate multiple
characters or a question mark ‘?’ to incidate a single character).
For additional information about this editor, see `Using the Ignored Files Editor`_
Using the Activity Settings Window
----------------------------------
.. index:: activity, recent changes, sync activity
The Activity window provides an in-depth account of recent synchronization
activity. It shows files that have not been synchronized because they are on
the ignored files list or because they cannot be synced in a cross-platform
manner due to containing special characters that cannot be stored on certain
file systems.
.. image:: images/settings_activity.png
:scale: 50 %
**Activity settings window**
You can open the Activity window in one of the following ways:
- Click 'Activity' in the left frame of the ownCloud Settings window.
- Invoke the window from the ownCloud Desktop Client menu by selecting ``Recent
Changes`` > ``Details...``. (See Using the Desktop Client Menu.)
Using the General Settings Window
---------------------------------
.. index:: general settings, auto start, startup, desktop notifications
The General settings window enables you to set general settings for the
ownCloud Desktop Client and provides information about the software version,
its creator, and the existance of any updates.
.. image:: images/settings_general.png
:scale: 50 %
**General settings window**
The settings and information contained in this window are as follows:
* ``Launch on System Startup`` checkbox: Provides the option to check (enable)
or uncheck (disable) whether the ownCloud Desktop Client launches upon system
startup. By default, this option is enabled (checked)once you have configured
your account.
* ``Show Desktop Nofications`` checkbox: Provides the option to check (enable)
or uncheck (disable) bubble notifications alerting you as to when a set of
synchronization operations is performed.
* ``Use Monochrome Icons`` checkbox: Provides the option to check (enable) or
uncheck (disable) the use of monochrome (visually less obtrusive) icons.
.. note:: This option can be useful on MAC OSX platforms.
* ``About`` field: Provides information about the software authors along with
pertinent build conditions.
.. note:: Information in this field can be valuable when submitting a support request.
* ``Updates`` field: Provides information about any available updates for the
ownCloud Desktop Client.
Using the Network Settings Window
---------------------------------
.. index:: proxy settings, SOCKS, bandwith, throttling, limiting
The Network settings window enables you to define network proxy settings as
well as limit the download and upload bandwidth utilization of file
synchronizations.
.. image:: images/settings_network.png
:scale: 50 %
**Network settings window**
Specifying Proxy Settings
^^^^^^^^^^^^^^^^^^^^^^^^^
A proxy server is a server (for example, a computer system or an application)
that functions as an intermediary contact for requests from clients that are
seeking resources from other servers. For the ownCloud Desktop Client, you can
define the following proxy settings:
* ``No Proxy`` option: Specifies that the ownCloud Client circumvent the default proxy configured on the system.
* ``Use system proxy`` option: Default setting. Follows the systems proxy
settings. On Linux systems, this setting uses the value of the variable
``http_proxy``.
* ``Specify proxy manually as`` option: Enables you to specify
the following custom proxy settings:
- ``HTTP(S)``: Used when you are required to use an HTTP(S) proxy server (for example, Squid or Microsoft Forefront TMG).
- ``SOCKSv5``: Typically used in special company LAN setups, or in combination with the OpenSSH
dynamic application level forwarding feature (see ``ssh -D``).
- ``Host``: Host name or IP address of the proxy server along with the port number. HTTP proxies
typically listen over Ports 8080 (default) or 3128. SOCKS servers typically listen over port 1080.
* ``Proxy Server requires authentication`` checkbox: Provides the option to check (enable/require) or
uncheck (disable/not require) proxy server authentication. When not checked, the proxy server must
be configured to allow anonymous usage. When checked, a proxy server username and password is required.
Bandwidth Limiting
^^^^^^^^^^^^^^^^^^
Synchronization of files between a client and server can utilized a lot of
bandwidth. Bandwidth limiting can assist in shaping the total download or
upload bandwidth (or both) of your client/server connection to a more
manageable level. By limiting your bandwidth usage, you can maintain free
bandwidth for other applications to use.
The ownCloud Desktop Client enables you to limit (throttle) the bandwidth usage
for both file downloads and file uploads. The Download Bandwidth field (for
data flowing from the ownCloud server to the client) provides the following
options:
- ``No limit`` option: The default setting for the client; specifies that there
are no limit settings on the amount of data downloaded from the server.
- ``Limit to <value> KBytes/s`` option: Limits (throttles) the bandwidth to
a customized value (in KBytes/second).
The Upload Bandwidth field (for data flowing from the ownCloud client to the
server) provides the following options:
- ``No limit`` option: The default setting for the client; specifies that there
are no limit settings on the amount of data downloaded from the server.
- ``Limit automatically``: When enabled, the ownCloud client surrenders
available bandwidth to other applications. Use this option if there are
issues with real time communication (for example, the use of IP phone or live
streaming) in conjunction with the ownCloud Client.
- ``Limit to <value> KBytes/s`` option: Limits (throttles) the bandwidth to a
customized value (in KBytes/second).
.. _ignoredFilesEditor-label:
Using the Ignored Files Editor
------------------------------
.. index:: ignored files, exclude files, pattern
You might have some 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* that is embedded in the ownCloud Desktop
Client.
.. image:: images/ignored_files_editor.png
:scale: 50%
Ignored Files Editor window
The :guilabel:`Ignored Files Editor` enables you to define customized patterns that the
ownCloud Client uses to identify files and directories that you want to exclude
from the synchronization process. For your convenience, the editor is
pre-populated with a default list of typically ignore patterns. These patterns
are contained in a system file (typically ``sync-exclude.lst``) located in the
ownCloud 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
unusable or result in undesired behavior.
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 idenfify an arbitrary number of
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, but might fail to load correctly.
Each pattern string in the list is preceded 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.
In addition to excluding files and directories that use patterns defined in
this list:
- The ownCloud Client always excludes files containing characters that cannot
be synchronized to other file systems.
- As of ownCloud Desktop Client version 1.5.0, 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`.

2
doc/ocdoc

@ -1 +1 @@
Subproject commit 2c3e584b2356dc4324e6e0720b7aa908aaa480a3
Subproject commit c612df399e3c775a2f9db1dc5e39d25920ab467b

15
doc/options.rst
View file

@ -1,24 +1,23 @@
When invoking the client from the command line, the following options are supported:
``-h``, ``--help``
shows all the below options (opens a window on Windows)
Displays all the options below or, when used on Windows, opens a window displaying all options.
``--logwindow``
open a window to show log output.
Opens a window displaying log output.
``--logfile`` `<filename>`
write log output to file <filename>. To write to stdout, specify `-`
as filename
Write log output to the file specified. To write to stdout, specify `-` as the filename.
``--logdir`` `<name>`
write each sync log output in a new file in directory <name>
Writes each synchronization log output in a new file in the specified directory.
``--logexpire`` `<hours>`
removes logs older than <hours> hours. (to be used with --logdir)
Removes logs older than the value specified (in hours). This command is used with ``--logdir``.
``--logflush``
flush the log file after every write.
Clears (flushes) the log file after each write action.
``--confdir`` `<dirname>`
Use the given configuration directory.
Uses the specified configuration directory.

8
doc/owncloud.1.rst
View file

@ -10,13 +10,9 @@ SYNOPSIS
DESCRIPTION
===========
ownCloud is a file synchronisation desktop utility based on mirall.
It synchronizes files on your local machine with an ownCloud Server. If you
make a change to the files on one computer, it will flow across the others
using this desktop sync clients.
The ownCloud Client is a file synchronization desktop utility based on mirall. It synchronizes files on your local computer, tablet, or handheld device with an ownCloud Server. If you make a change to the files on one device, the change is propagated to all other syncrhonized devices using the desktop synchronization clients.
Normally you start the client by click on the desktop icon or start from the
application menu. After starting an ownCloud icon appears in the system tray.
Normally, you start the client by clicking on the desktop icon or by starting it from the client application menu. After starting, an ownCloud icon appears in the computer system tray or on your tablet or handheld device.
Options
=======

28
doc/owncloudcmd.1.rst
View file

@ -9,38 +9,38 @@ SYNOPSIS
DESCRIPTION
===========
owncloudcmd is the command line tool for the ownCloud file synchronisation
desktop utility, based on mirall.
owncloudcmd is the command line tool used for the ownCloud file synchronization
desktop utility. This command line tool is based on mirall.
Contrary to the :manpage:`owncloud(1)` GUI client, `owncloudcmd` will only
perform a single sync run and then exit. It thus replaces the `ocsync` binary
used for the same purpose in earlier releases.
Contrary to the :manpage:`owncloud(1)` GUI client, `owncloudcmd` only performs
a single sync run and then exits. In so doing, `owncloudcmd` replaces the
`ocsync` binary used for the same purpose in earlier releases.
A sync run will sync a single local directory with a WebDAV share on a
A *sync run* synchronizes a single local directory using a WebDAV share on a
remote ownCloud server.
To invoke the command line client, provide the local and the remote repository:
The first parameter is the local directory. The second parameter is
the server URL.
.. note:: Prior to 1.6, the tool only accepted ``owncloud://`` or ``ownclouds://``
in place of ``http://`` and ``https://`` as a scheme. See ``Examples``
for details.
.. note:: Prior to the 1.6 release of owncloudcmd, the tool only accepted
``owncloud://`` or ``ownclouds://`` in place of ``http://`` and ``https://`` as
a scheme. See ``Examples`` for details.
OPTIONS
=======
``--confdir`` `PATH`
The configuration dir where `csync.conf` is located
Specifies the configuration directory where `csync.conf` is located.
``--silent``
Don't give verbose log output
Inhibits verbose log output.
``--httpproxy http://[user@pass:]<server>:<port>``
Use ``server`` as HTTP proxy
Uses ``server`` as HTTP proxy.
Example
=======
To sync the ownCloud directory ``Music`` to the local directory ``media/music``
To synchronize the ownCloud directory ``Music`` to the local directory ``media/music``
through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
the command line would be::
@ -49,7 +49,7 @@ the command line would be::
https://server/owncloud/remote.php/webdav/Music
Using the legacy scheme, it would look like this::
Using the legacy scheme, it would be::
$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \

57
doc/owncloudcmd.rst
View file

@ -1,44 +1,43 @@
The ownCloud Client packages come with a command line client which
can be used to synchronize ownCloud files to client machines. The
command line client is called ``owncloudcmd``.
The ownCloud Client packages contain a command line client that can be used to
synchronize ownCloud files to client machines. The command line client is
called ``owncloudcmd``.
owncloudcmd performs a single sync run and then exits.
That means that it processes the differences between client- and
server directory and propagates the files to get both repositories
on the same status. Contrary to the GUI based client, it does not
repeat syncs on its own. It does also not monitor for file system
changes.
owncloudcmd performs a single *sync run* and then exits the synchronization
process. In this manner, owncloudcmd processes the differences between client
and server directories and propagates the files to bring both repositories to
the same state. Contrary to the GUI-based client, owncloudcmd does not repeat
synchronizations on its own. It also does not monitor for file system changes.
To invoke the command line client, the user has to provide the local
and the remote repository urls::
To invoke the owncloudcmd, you must provide the local and the remote repository
urls using the following command::
owncloudcmd [OPTIONS...] sourcedir owncloudurl
where ``sourcedir`` is the local directory and ``owncloudurl`` is
the server url.
the server URL.
.. note:: Prior to 1.6, the tool only accepted ``owncloud://`` or
``ownclouds://`` in place of ``http://`` and ``https://``
as a scheme. See ``Examples`` for details.
.. note:: Prior to the 1.6 version of owncloudcmd, the tool only accepted
``owncloud://`` or ``ownclouds://`` in place of ``http://`` and ``https://`` as
a scheme. See ``Examples`` for details.
These are other comand line switches supported by owncloudcmd:
Other comand line switches supported by owncloudcmd include the following:
``--silent``
Don't give verbose log output
- ``--silent``
Supresses verbose log output.
``--confdir`` `PATH`
Fetch or store configuration in this custom config directory
- ``--confdir`` `PATH`
Fetches or stores configuration in the specified configuration directory.
``--httpproxy http://[user@pass:]<server>:<port>``
Use ``server`` as HTTP proxy
- ``--httpproxy http://[user@pass:]<server>:<port>``
Uses the specified ``server`` as the HTTP proxy.
Credential Handling
~~~~~~~~~~~~~~~~~~~
By default, owncloudcmd reads the client configuration and uses the credentials
of the GUI sync client. If no client was configured or to use a different user
to sync, the user password setting can be specified with the usual URL pattern,
for example::
of the GUI syncrhonization client. If no client is configured, or if you choose
to use a different user to synchronize, you can specify the user password
setting with the usual URL pattern. For example::
https://user:secret@192.168.178.2/remote.php/webdav
@ -46,16 +45,16 @@ for example::
Example
~~~~~~~
To sync the ownCloud directory ``Music`` to the local directory ``media/music``
through a proxy listening on port ``8080`` on the gateway machine ``192.168.178.1``,
the command line would be::
To synchronize the ownCloud directory ``Music`` to the local directory
``media/music`, through a proxy listening on port ``8080``, and on a gateway
machine using IP address ``192.168.178.1``, the command line would be::
$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \
https://server/owncloud/remote.php/webdav/Music
Using the legacy scheme, it would look like this::
Using the legacy scheme, the command line would be::
$ owncloudcmd --httpproxy http://192.168.178.1:8080 \
$HOME/media/music \

265
doc/troubleshooting.rst
View file

@ -1,158 +1,223 @@
Appendix C: Troubleshooting
===========================
If the client fails to start syncing it basically can have two
basic reasons: Either the server setup has a problem or the client
has a bug. When reporting bugs, it is crucial to find out what part
of the system causes the problem.
The following two general issues can result in failed synchronization:
Identifying basic functionality problems
- The server setup is incorrect.
- The client contains a bug.
When reporting bugs, it is helpful if you first determine what part of the
system is causing the issue.
Identifying Basic Functionality Problems
----------------------------------------
:Perform a general ownCloud Server test:
A very first check is to verify that you can log on to ownClouds web
application. Assuming your ownCloud instance is installed at
``http://yourserver.com/owncloud``, type
``http://yourserver.com/owncloud/`` into your browsers address bar.
:Performing a general ownCloud Server test:
The first step in troubleshooting synchronization issues is to verify that
you can log on to the ownCloud web application. To verify connectivity to the
ownCloud server:
- Open a browser window and enter the server address to your own server in the location/address bar.
For example, if your ownCloud instance is installed at URL address
``http://yourserver.com/owncloud``, enter ``http://yourserver.com/owncloud/``
into your browsers location/address bar.
If you are not prompted to enter your user name and password, or if you
see a red warning box on the page, your server setup is not correct or needs
fixes. Please verify that your server installation is working correctly.
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.
:Ensure the WebDAV API is working:
If all desktop clients fail to connect to ownCloud, but the access via the
web interface works, the problem often is a mis-configuration of the WebDAV
API.
If all desktop clients fail to connect to the ownCloud Server, but access
using the web interface functions properly, the problem is often a
misconfiguration of the WebDAV API.
The ownCloud client uses the built-in WebDAV access of the server content.
Verify that you can log on to ownClouds WebDAV server. Assuming your ownCloud
instance is installed at ``http://yourserver.com/owncloud``, type
``http://yourserver.com/owncloud/remote.php/webdav`` into your browsers
address bar.
The ownCloud Client uses the built-in WebDAV access of the server content.
Verify that you can log on to ownClouds WebDAV server. To verify connectivity
with the ownCloud WebDAV server:
If you are prompted, but the authentication fails even though the credentials
your provided are correct, please ensure that your authentication backend
is configured properly.
- Open a browser window and enter the address to the ownCloud WebDAV server.
For example, if your ownCloud instance is installed at
``http://yourserver.com/owncloud``, your WebDAV server address is
``http://yourserver.com/owncloud/remote.php/webdav``.
If you are prompted for your username and password but, after providing the
correct credentials, authentication fails, please ensure that your
authentication backend is configured properly.
:Use a WebDAV command line tool to test:
A more sophisticated test is to use a WebDAV command line client and log
into the ownCloud WebDAV server, such as a little app called cadaver,
available on Linux. It can be used to further verify that the WebDAV server is
running properly, for example by performing PROPFIND calls:
A more sophisticated test method for troubleshooting syncrhonization issues
is to use a WebDAV command line client and log into the ownCloud 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.
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.
``propget .`` called within cadaver will return some properties of the current
directory and thus be a successful WebDAV connect.
Isolating other issues
----------------------
If the sync result is unreliable, please ensure that the folder synced with
ownCloud is not shared with other syncing apps.
Other issues can affect synchronization of your ownCloud files:
.. note:: Syncing the same directory with ownCloud and other sync software such
as Unison, rsync, Microsoft Windows Offline Folders or cloud services
such as DropBox or Microsoft SkyDrive is not supported and should
not be attempted. In the worst case, doing so can result in data
loss.
- If you find that the results of the synchronizations are unreliable, please
ensure that the folder to which you are synchronizing is not shared with
other synchronization applications.
If some files do not get take a look at the sync protocol. Some files are
automatically automatically being ignored because they are system files,
others get ignored because their file name contains characters that cannot
be represented on certain file systems. See :ref:`_ignored-files-label` for
details.
.. note:: Synchronizing the same directory with ownCloud and other
synchronization software such as Unison, rsync, Microsoft Windows Offline
Folders, or other cloud services such as DropBox or Microsoft SkyDrive is not
supported and should not be attempted. In the worst case, it is possible that
synchronizing folders or files using ownCloud and other synchronization
software or services can result in data loss.
If you are operating your own server and use the local storage backend (the
default), make sure that ownCloud has exclusive access to the directory.
- If you find that only specific files are not synrchronized, the
synchronization protocol might be having an effect. Some files are
automatically ignored because they are system files, other files might be
ignored because their filename contains characters that are not supported on
certain file systems. For more information about ignored files, see
:ref:`_ignored-files-label`.
.. note:: The data directory on the server is exclusive to ownCloud and must
not be modified manually.
- If you are operating your own server, and use the local storage backend (the
default), make sure that ownCloud has exclusive access to the directory.
If you are using a different backend, you can try to exclude a bug in the
backend by reverting to the local backend.
.. note:: The data directory on the server is exclusive to ownCloud and must not be modified manually.
Logfiles
--------
If you are using a different file backend on the server, you can try to exclude a bug in the
backend by reverting to the built-in backend.
Doing effective debugging requires to provide as much as relevant logs as
possible. The log output can help you with tracking down problem, and if you
report a bug, you're advised to include the output.
Log Files
---------
Client Logfile
~~~~~~~~~~~~~~
Effectively debugging software requires as much relative information as can be
obtained. To assist the ownCloud support personnel, please try to provide as
many relevant logs as possible. Log output can help with tracking down
problems and, if you report a bug, log output can help to resolve an issue more
quickly.
Start the client with ``--logwindow``. That opens a window providing a view
on the current log. It provides a Save button to let you save the log to a
file.
Obtaining the Client Log File
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also open a log window for an already running session, by simply
starting the client again with this parameter. Syntax:
To obtain the client log file:
1. Open the ownCloud Desktop Client.
2. Press F12 on your keyboard.
The Log Output window opens.
.. image:: images/log_output_window.png
3. Click the 'Save' button.
The Save Log File window opens.
.. image:: images/save_log_file.png
4. Migrate to a location on your system where you want to save your log file.
5. Name the log file and click the 'Save' button.
The log files is saved in the location specifed.
Alternatively, you can launch the ownCloud Log Output window using the
``--logwindow`` command. After issuing this command, the Log Output window
opens to show the current log. You can then follow the same procedures
mentioned above to save the log to a file.
.. note:: You can also open a log window for an already running session, by
restarting the client using the following command:
* Windows: ``C:\Program Files (x86)\ownCloud\owncloud.exe --logwindow``
* Mac OS X: ``/Applications/owncloud.app/Contents/MacOS/owncloud --logwindow``
* Linux: ``owncloud --logwindow``
It is also possible to directly log to a directory, which is an useful option
in case the problem only happens ocassionally. In that case it is better to
create a huge amount of data, as the log window has a limited buffer.
Saving Files Directly
~~~~~~~~~~~~~~~~~~~~~
To write logs to disk, start the client with ``--logfile <file>``, where
``<file`` is the file you want to log to, or ``--logdir <dir>``, where ``<dir>``
is an existing directory. In case of ``--logdir``, each sync run will create a
new file. To limit the amount of data that accumulates over time, there is another
useful parameter: ``--logexpire <hours>```. If that is combined with ```--logdir```
the client automatically erases log data in that directory that is older than the
given expiry period.
The ownCloud client enables you to save log files directly to a predefined file
or directory. This is a useful option for troubleshooting sporadic issues as
it enables you to log large amounts of data and bypasses the limited buffer
settings associated with the log window.
For example, for a long running test where you intend to keep the log data of the
last two days, this would be the command line:
To save log files to a file or a directory:
1. To save to a file, start the client using the ``--logfile <file>`` command,
where ``<file>`` is the filename to which you want to save the file.
2. To save to a directory, start the client using the ``--logdir <dir>`` command, where ``<dir>``
is an existing directory.
When using the ``--logdir`` command, each sync run creates a new file. To limit
the amount of data that accumulates over time, you can specify the
``--logexpire <hours>`` command. When combined with the ``--logdir`` command,
the client automatically erases saved log data in the directory that is older
than the specified number of hours.
As an example, to define a test where you keep log data for two days, you can
issue the following command:
```
owncloud --logdir /tmp/owncloud_logs --logexpire 48
```
ownCloud server Logfile
~~~~~~~~~~~~~~~~~~~~~~~
ownCloud server Log File
~~~~~~~~~~~~~~~~~~~~~~~~
The ownCloud server maintains an ownCloud specific logfile as well. It can and
must be enabled through the ownCloud Administration page. There you can adjust
the loglevel. It is advisable to set it to a verbose level like ``Debug`` or
``Info``.
The ownCloud server also maintains an ownCloud specific log file. This log file
must be enabled through the ownCloud 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``.
The logfile can be viewed either in the web interface or can be found in the
filesystem in the ownCloud server data dir.
You can view the server log file using the web interface or you can open it
directly from the file system in the ownCloud server data directory.
Webserver Logfiles
~~~~~~~~~~~~~~~~~~
.. todo:: Need more information on this. How is the log file accessed?
Need to explore procedural steps in access and in saving this file ... similar
to how the log file is managed for the client. Perhaps it is detailed in the
Admin Guide and a link should be provided from here. I will look into that
when I begin heavily editing the Admin Guide.
Also, please take a look at your webservers error log file to check if there
are problems. For Apache on Linux, the error logs usually can be found at
``/var/log/apache2``. A file called ``error_log`` shows errors like PHP code
problems. A file called ``access_log`` usually records all requests handled
by the server. Especially the access_log is a very good debugging tool as the
log line contains a lot of information of every request and it's result.
Webserver Log Files
~~~~~~~~~~~~~~~~~~~
It can be helpful to view your webservers error log file to isolate any
ownCloud-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.
- ``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.
More information about the apache logging can be found at
You can find more information about Apache logging at
``http://httpd.apache.org/docs/current/logs.html``.
Core Dumps
----------
In case of crashes of the client software, having a core dump helps to
debug the issue tremendously.
On MAC OS X 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 ownCloud Customer Support tremendously in the debugging
process.
The client is able to write a core dump in case of crashing on Linux and
MacOSX. To enable that, the environment variable ``OWNCLOUD_CORE_DUMP`` has
to be defined.
To enable the writing of core dump files, you must define the
``OWNCLOUD_CORE_DUMP`` environment variable on the system.
For example
For example:
```
OWNCLOUD_CORE_DUMP=1 owncloud
```
starts the client with core dumping enabled. Core dumps appear in the
current working directory, and since they can be fairly large, it is
important to have plenty of disk space when running with dumps enabled.
This command starts the client with core dumping enabled and saves the files in
the current working directory.
If a core dump file should be transfered back to the developers it
should be compressed properly before.
.. 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.
Also, due to their size, we strongly recommend that you properly compress any
core dump files prior to sending them to ownCloud Customer Support.