OwnCloud Manual
OwnCloud Manual
OwnCloud Manual
The WebUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
WebUI Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Custom Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Session Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Storage Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
External Storage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Synchronisation Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Synchronizing with OS X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Introduction
Welcome to ownCloud: your self-hosted file sync and share solution.
ownCloud is open source file sync and share software for everyone from individuals
operating the free ownCloud Server edition, to large enterprises and service providers
operating the ownCloud Enterprise Subscription. ownCloud provides a safe, secure,
and compliant file synchronization and sharing solution on servers that you control.
You can share one or more files and folders on your computer, and synchronize them
with your ownCloud server. Place files in your local shared directories, and those files
are immediately synchronized to the server and to other devices using the ownCloud
Desktop Sync Client, Android app, or iOS app. To learn more about the ownCloud
desktop and mobile clients, please refer to their respective manuals:
The WebUI
WebUI Overview
Introduction
You can access your files with the ownCloud Web interface, as well as: create, preview,
edit, delete, share, and re-share files.
Introduction | 1
File Controls
When you mouseover, or hover over, a file in the Files view, as in the image below,
ownCloud displays three file controls. These are:
1. Marking Favorites
2. Sharing Files
3. The Overflow Menu
Marking Favorites
Click the star to the left of the file icon to mark it as a favorite, and quickly find all of
your favorites with the Favorites filter on the left sidebar.
2 | WebUI Overview
Sharing Files
The sharing files control is a shortcut to the file and folder sharing functionality within
ownCloud. ownCloud sharing supports:
WebUI Overview | 3
Display File Details
When you display details about a file, by clicking btn:[Details] in the Overflow Menu, a
set of tabs (or views) are available. These are:
View Description
Details This shows details about a file, such as its name, size, and when it was
created or last updated.
Activity This shows a history of activity on the file, such as when it was
created, updated, and shared.
Sharing It’s here that shares are managed. To know more, refer to the Sharing
Files section.
Version This shows a history of all the versions of the file. This is not available
for folders.
You can see an example of the Activity view in the image below.
• Firefox 14+
• Chrome 18+
• Safari 5+
• IE11+ (except Compatibility Mode)
The ownCloud user interface contains the following fields and functions:
• Apps Selection Menu: Located in the upper left corner, click the arrow to open a
dropdown menu to navigate to your various available apps.
• Apps Information field: Located in the left sidebar, this provides filters and tasks
associated with your selected app. For example, when you are using the Files apps
you have a special set of filters for quickly finding your files, such as files that have
been shared with you, and files that you have shared with others. You’ll see
different items for other apps.
• Application View: The main central field in the ownCloud user interface. This field
displays the contents or user features of your selected app.
• Navigation Bar: Located over the main viewing window (the Application View),
this bar provides a type of breadcrumbs navigation that enables you to migrate to
higher levels of the folder hierarchy up to the root level (home).
• New button: Located in the Navigation Bar, the btn:[New] button enables you to
create new files, new folders, or upload files.
You can also drag and drop files from your file manager into the
• Search field: Click on the btn:[magnifier] in the upper right hand corner of to
search for files.
• Gallery button. This looks like four little squares, and takes you directly to your
image gallery.
User Preferences
As a user, you can manage your personal settings.
1. Clicking on your username in the top, right corner of your ownCloud instance.
6 | User Preferences
If you are an administrator, you can also manage users and administer
the server. These links do not appear to a non-admin user.
The options listed in the Personal Settings Page depend on the applications that are
enabled by the administrator. Some of the features you will see include the following.
User Preferences | 7
• ownCloud version.
To upload or create new files or folders directly in an ownCloud folder click on the
btn:[New] button in the navigation bar (this is the + button). There, as in the image
above, you can see links to:
• btn:[Upload a new file] This uploads files from your computer into ownCloud. You
can also upload files by dragging and dropping them from your file manager.
• btn:[Create a new text file] This creates a new text file and adds the file to your
current folder.
• btn:[Create a new folder] This creates a new folder in the current folder.
You can select one or more files or folders by hovering over them (as in the image
below) and clicking on their checkboxes. To select all files in the current directory,
click on the checkbox located at the top of the files listing.
Option Description
All files The default view; displays all files that you have access to
Favorites Files or folders marked with the yellow star
Shared with Displays all files shared with you by another user or group
you
Shared with Displays all files that you have shared with other users or groups
others
Shared by Displays all files that are shared by you via public link
link
External Files that you have access to on external storage devices and services
Storage such as Dropbox, Google, and Amazon S3
Move Files
You can move files and folders by dragging and dropping them into any directory.
Play Videos
You can play videos in ownCloud with the Video Player app, by clicking once on the
file. Please note, video streaming by the native ownCloud video player depends on
your Web browser and the video’s format.
Settings
The Settings gear icon, in the lower left-hand corner of the ownCloud window, allows
you to show or hide hidden files in your ownCloud Web interface. These are also called
dotfiles, because they are prefixed with a dot, e.g. .mailfile.
The dot tells your operating system to hide these files in your file browsers, unless you
choose to display them. Usually, these are configuration files, so having the option to
hide them reduces clutter.
Preview Files
ownCloud can display thumbnail previews for images, MP3 covers, and text files, if
this is enabled by your server administrator. You can also display uncompressed text,
OpenDocument, videos, and image files in the ownCloud embedded viewers by
clicking on the file name. There may be other file types you can preview if your
ownCloud administrator has enabled them. If ownCloud cannot display a file, it will
start a download process and downloads the file to your computer.
Comments
Introduction
In ownCloud, you can add one or more comments on both files and folders. This
section describes how to add, edit, and delete comments.
10 | Comments
Unresolved directive in modules/user_manual/pages/files/webgui/comments.adoc -
include::{partialsdir}/direct_file_access_tip.adoc[]
Add Comments
Use the Details view, in The Overflow Menu, to add and read comments on any file or
folder. Comments are visible to everyone who has access to the file or folder. To add a
comment, as in the example below, click the btn:[Comments] tab in the Details view,
write a comment in the New Comment field, and click btn:[Post].
Edit Comments
To edit an existing comment on a file or folder, hover the mouse over the comment and
you will see a pencil icon appear. By clicking on the pencil, the btn:[Edit Comment]
field will appear, pre-filled with the comment text. Change the text as necessary and
click btn:[Save]. If you change your mind, just click btn:[Cancel].
Delete Comments
To delete an existing comment on a file or folder, as with editing comments, hover the
mouse over the comment and you will see a pencil icon appear. Click the pencil, and a
rubbish bin icon appears on the far right-hand side of the comment author’s name,
above the btn:[Edit Comment] text field. Click the btn:[rubbish bin], and the comment
will be deleted after a few seconds.
Comments | 11
Custom Groups
Introduction
In previous versions of ownCloud, if you wanted to share a file or a folder with more
than one person, you had to share it either with many people individually, or share to
one or more groups. However, you could only share with groups which your ownCloud
administrator had already created.
This wasn’t the most efficient way to work. To address that, as of ownCloud 10.0, you
can now create your own groups on-the-fly, through a feature called "Custom Groups".
Here’s how to use it.
To create a new custom group, in the text field at the top where you see the
placeholder text: "Group name", add the group name and click btn:[Create group].
After a moment or two, you’ll see the new custom group appear in the groups list.
1. Custom groups are visible only to members of the group, but not to
anyone outside the group; and
2. ownCloud administrators can see and modify all custom groups of an
instance.
12 | Custom Groups
Managing Group Members
To add or remove users in a custom group, click your role (1), which will likely be
"Member" (at least at first), and you’ll see a panel appear on the right-hand side
listing the group’s users and their roles. In the "Add user to this group field" at the
top of the panel (2), start typing the name of the user that you want to add.
After a moment or two, you’ll see a list of users that match what you’ve typed appear
(if there are any) in a popup list. Click the one that you want, and they’ll be added to
the group. Finally, you’ll see a confirmation at the top of the page (3), indicating that
the user’s been added to the custom group.
Members can only use a group for sharing, whereas group admins can
manage a group’s members, change a group’s name, change members’
roles, and delete groups.
To share a file or folder with your custom group, open the sharing panel (1). Then, in
the "User and Groups" field (2), type part of the name of the custom group and wait a
moment or two.
The name of the group should be displayed in a popup list, which you can see in the
screenshot above. Click on it, and the file or folder will then be shared with your
custom group with all permissions initially set.
Custom Groups | 13
Changing Group Names
If you want to change the name of the custom group, mouseover the group’s name in
the custom groups list, where you will see a pencil appear to the right of the existing
name. Click it, and a text field will appear, pre-populated with the existing name.
Change the name and click enter, and the name will be changed.
The recommended method for syncing your ownCloud server with Android and Apple
iOS devices is by using the ownCloud mobile apps.
To connect to your ownCloud server with the ownCloud mobile apps, use the base
URL and folder only:
example.com/owncloud
In addition to the mobile apps provided by ownCloud, you can use other apps to
connect to ownCloud from your mobile device using WebDAV. WebDAV Navigator is a
good (proprietary) app for Android devices, iPhones, and BlackBerry devices. The URL
to use on these is:
example.com/owncloud/remote.php/dav/files/USERNAME/
Use the davs:// protocol to connect the Nautilus file manager to your ownCloud share:
davs://example.com/owncloud/remote.php/dav/files/USERNAME/
To access your ownCloud files using the Dolphin file manager in KDE, use the
webdav:// protocol:
1. Open Dolphin and click btn:[Network] in the left hand menu:Places[] column.
2. Click on the icon labeled btn:[Add a Network Folder].
The resulting dialog should appear with WebDAV already selected.
3. If WebDAV is not selected, select it.
4. Click btn:[Next].
5. Enter the following settings:
◦ Name: The name you want to see in the Places bookmark, for example
ownCloud.
◦ User: The ownCloud username you used to log in, for example admin.
◦ Server: The ownCloud domain name, for example example.com (without http://
before or directories afterwards).
◦ Folder: Enter the path owncloud/remote.php/dav/files/USERNAME/.
6. (Optional) Check the btn:[create] icon checkbox for a bookmark to appear in the
menu:Places[] column.
7. (Optional) Provide any special settings or an SSL certificate in the btn:[Port &
Encrypted] checkbox.
1. Install the davfs2 WebDAV filesystem driver, which allows you to mount WebDAV
shares just like any other remote filesystem. Use this command to install it on
4. Then create an owncloud directory in your home directory for the mountpoint, and
.davfs2/ for your personal configuration file:
mkdir ~/owncloud
mkdir ~/.davfs2
cp /etc/davfs2/secrets ~/.davfs2/secrets
6. Set yourself as the owner and make the permissions read-write owner only:
7. Add your ownCloud login credentials to the end of the secrets file, using your
ownCloud server URL and your ownCloud username and password:
example.com/owncloud/remote.php/dav/files/USERNAME/ <username>
<password>
example.com/owncloud/remote.php/dav/files/USERNAME/
/home/<username>/owncloud davfs user,rw,auto 0 0
9. Then test that it mounts and authenticates by running the following command. If
you set it up correctly you won’t need root permissions:
mount ~/owncloud
Now every time you login to your Linux system your ownCloud share should
automatically mount via WebDAV in your ~/owncloud directory. If you prefer to mount
it manually, change auto to noauto in /etc/fstab.
Known Issues
Solution
If you experience trouble when you create a file in the directory, edit
/etc/davfs2/davfs2.conf and add:
use_locks 0
Solution
If you use a self-signed certificate, you will get a warning. To change this, you need to
configure davfs2 to recognize your certificate. Copy mycertificate.pem to
/etc/davfs2/certs/. Then edit /etc/davfs2/davfs2.conf and uncomment the line
servercert. Now add the path of your certificate as in this example:
servercert /etc/davfs2/certs/mycertificate.pem
and should only be used if the ownCloud server runs on Apache and
mod_php, or NGINX 1.3.8+. You can use a tool like ocsmount to
mount without those issues.
https://example.com/owncloud/remote.php/dav/files/USERNAME/
3. Click btn:[Connect].
The device connects to the server.
For added details about how to connect to an external server using Mac OS X,
check the wikihow documentation
If you must use the native Windows implementation, you can map ownCloud to a new
drive. Mapping to a drive enables you to browse files stored on an ownCloud server
the way you would files stored in a mapped network drive.
Using this feature requires network connectivity. If you want to store your files offline,
use the ownCloud Desktop Client to sync all files on your ownCloud to one or more
directories of your local hard drive.
Prior to mapping your drive, you must permit the use of Basic
Authentication in the Windows Registry. The procedure is documented
in KB841215 and differs between Windows XP/Server 2003 and
Windows Vista/7. Please follow the Knowledge Base article before
proceeding, and follow the Vista instructions if you run Windows 7.
The following example shows how to map a drive using the command line. To map the
drive:
Example:
Though not recommended, you can also mount the ownCloud server
For example:
https://example.com/owncloud/remote.php/dav/files/USERNAME/
To use Cyberduck:
2. Specify the appropriate port. The port you choose depends on whether or not your
ownCloud server supports SSL. Cyberduck requires that you select a different
connection type if you plan to use SSL. For example:
80 (for WebDAV)
443 (for WebDAV (HTTPS/SSL))
3. Use the More Options drop-down menu to add the rest of your WebDAV URL into
the `Path' field. For example:
remote.php/dav/files/USERNAME/
https://example.com/owncloud/public.php/webdav
in a WebDAV client, use the share token as username and the (optional) share
password as password.
Known Problems
Solution 1
The Windows WebDAV Client might not support Server Name Indication (SNI) on
encrypted connections. If you encounter an error mounting an SSL-encrypted
ownCloud instance, contact your provider about assigning a dedicated IP address for
your SSL-based server.
Solution 2
The Windows WebDAV Client might not support TSLv1.1 / TSLv1.2 connections. If you
have restricted your server config to only provide TLSv1.1 and above the connection to
your server might fail. Please refer to the WinHTTP documentation for further
information.
Problem: The File Size Exceeds the Limit Allowed and Cannot be Saved
Solution
Windows limits the maximum size a file transferred from or to a WebDAV share may
have. You can increase the value FileSizeLimitInBytes in
HKEY_LOCAL_MacHINE\SYSTEM\CurrentControlSet\Services\WebClient\Para
meters by clicking on btn:[Modify].
To increase the limit to the maximum value of 4GB, select Decimal, enter a value of
4294967295, and reboot Windows or restart the WebClient service.
Problem: Accessing your files from Microsoft Office via WebDAV fails
Solution
Known problems and their solutions are documented in the KB2123563 article.
Solution
You cannot download more than 50 MB or upload large Files when the upload takes
longer than 30 minutes using Web Client in Windows 7.
Error 0x80070043 "The network name cannot be found." while adding a network
drive.
Solution
To move a file:
To get the file id of a file, regardless of location, you need to make a PROPFIND
request. This request requires two things:
<?xml version="1.0"?>
<a:propfind xmlns:a="DAV:" xmlns:oc="http://owncloud.org/ns">
<!-- retrieve the file's id -->
<a:prop><oc:fileid/></a:prop>
</a:propfind>
With the file created, make the request by running the following Curl command:
This will return an XML response payload similar to the following example. It contains
the relative path to the file and the fileid of the file.
<?xml version="1.0"?>
<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns"
xmlns:cal="urn:ietf:params:xml:ns:caldav" xmlns:cs="http://calendarserver.org/ns/"
xmlns:card="urn:ietf:params:xml:ns:carddav" xmlns:oc="http://owncloud.org/ns">
<d:response>
<d:href>/remote.php/dav/files/admin/Photos/San%20Francisco.jpg</d:href>
<d:propstat>
<d:prop>
<oc:fileid>4</oc:fileid>
</d:prop>
<d:status>HTTP/1.1 200 OK</d:status>
</d:propstat>
</d:response>
</d:multistatus>
Sharing Files
Introduction
Clicking the share icon on any file or folder opens the Details view on the right, where
the Share tab has focus.
26 | Sharing Files
If your ownCloud server is the Enterprise edition, you may also have access to
Sharepoint and Windows Network Drive file shares. These have special status icons.
An icon with a red plugin and background means you have to enter a login to get
access to the share.
Creating Shares
To share a file or folder, immediately below the Share tab, you will see a text field. In
this field, you can enter any number of users (whether local to your ownCloud server
or remote) or groups who you would like to share the file or folder with.
If username auto-completion is enabled, when you start typing the user or group name
ownCloud will automatically complete it for you, if possible.
Sharing Files | 27
From 10.0.8, user and group name search results are dependent on a
new configuration setting, called user.search_min_length (it is set to 4
by default). This setting helps to aid search performance but requires
After a file or folder has been shared, Share Permissions can be set on it. In the image
below, you can see that the directory "event-Photos" is shared with the user "pierpont",
who can share, edit, create, change, and delete the directory.
If a share recipient has "can edit" privileges and moves files or folders out of the
share, ownCloud stores a backup copy of the moved file/folder in the Deleted Files
(Trash) of the share’s owner. The user who moved the file/folder out of the share still
has the original copy there, along with its attached metadata.
That way, the files/folders are not permanently lost. By clicking the btn:[Restore] link,
next to the respective file or folder, ownCloud will restore these files/folders to their
original location.
28 | Sharing Files
Restoring files restores the backup copy for all users, including the
user that originally moved them, into the original folder.
Users can also share files and folders with guest users. To do so, your ownCloud
administrator will need to have installed the Guest application.
If it’s already installed, in the User and Groups field of the Sharing panel, type the
email address of a user who is not already a user in your ownCloud installation. You
will then see a popup appear with the suffix (guest), as in the screenshot below.
After you do that, the content will be shared with the user with all permissions
applied, except for the ability to share with other users.
Sharing Files | 29
Updating Shares
To change any of the properties of a share, again, you first need to view the Share tab.
From there, you can:
This functionality is already described in other parts of this documentation and won’t
be specifically covered here.
Deleting Shares
Despite the name of this section, you don’t actually delete a share. Rather what you do
is remove the access of user’s to whom it’s already been shared with. When all users
access to a shared resource has been removed, the resource is no longer shared.
To do that, you need to click on the btn:[rubbish bin] icon, on the far right-hand side of
the name of each user it’s been shared with, who should no longer have access to it.
Renaming Shares
Both the sharer and all share recipients can rename a share at any time. However,
when one user renames a share, it only renames their version; no other users see the
new share name. Essentially, the share name remains the same for all other users.
This feature may seem a little strange; however, it provides flexibility for all users to
30 | Sharing Files
manage their files and folders as they see fit.
When you do so, you’ll see a password field appear. In there, add the password that
the user will need to enter to access the shared resource and press the return key.
If you click it, a new textbox will appear above the "Collaborative tags" field,
populated with the link’s URI (2).
Only people who have access to the file or folder can use the link.
Sharing Files | 31
• A local share can only be "expired" (or deleted) by clicking the btn:[trash can] icon
Share Permissions
Shares can have a combination of the following five permission types:
Permission Definition
can share Allows the users you share with to re-share
can edit Allows the users you share with to edit your shared files, and to
collaborate using the Documents app
create Allows the users you share with to create new files and add them to
the share
change Allows uploading a new version of a shared file and replacing it
delete Allows the users you share with to delete shared files
32 | Sharing Files
To create one:
1. View the sharing panel of the folder that you want to share as a Drop Folder, select
menu:Public Links[Create public link].
2. As with other shares, provide the name in the "Link Name" field.
3. Check btn:[Allow editing], un-check btn:[Show file listing], and then un-check
btn:[Allow editing].
4. Finally, click btn:[Save] to complete creation of the share.
Now, as with other public links, you can copy the link to the share and give it out, as
and when necessary.
Sharing Files | 33
When users open the share link, they will see a page where they can either click to
select files to share, or drag-and-drop files directly to share them. After the file’s been
successfully uploaded, they’ll see (where possible) a preview of the file that has been
uploaded.
Tagging Files
Introduction
In ownCloud, you can assign one or more tags to files and folders. To do so, go to the
"Details" view, inside The Overflow Menu.
There, you’ll see a text field, with the placeholder text "Collaborative tags" if no tags
have yet been added, below the file’s icon, name, and other details.
In that field, type the tag’s name. If you want to use multiple words, there is no need
to use single or double-quotes. Type as many words as you want for the tag name.
34 | Tagging Files
When you press the return key your tag will be saved.
All tags are collaborative tags, so they are shared by all users on your
ownCloud server.
When you place the cursor inside the tags field, and as you type the tag name, a list of
the collaborative tags will appear. If you type a new tag name, the visible tags list will
be filtered, based on the text that you’ve typed.
If you see a tag in the list which is what you had intended to type, or is a better fit than
what you had in mind, click on it, and it will be added to the file or folder’s tag list.
This can save you a lot of time and effort.
Edit Tags
To edit a tag, click the pencil icon on the far right-hand side of the tag’s name, in the
tags popup list. This will display a text box, containing the tag’s name. Be sure that
you want to change the tag’s name, as it will be updated for all users.
Delete Tags
To delete a tag, as above, click the pencil icon on the far right-hand side of the tag’s
name, in the tags popup list. Next to the text box containing the tag’s name, you will
also see a delete icon.
Click this to remove the tag from the collaborative tag’s list. As with renaming a tag,
remember that deleting a tag removes it for all users. So please be sure that you want
to do this.
Tagging Files | 35
Filter By Tag
To filter by tag, use the Tags filter on the left sidebar of the Files page. There are
three types of tags:
Tag Description
Visible All users may see, rename, and apply these tags to files and folders
Restricted Tags are assignable and editable only to the users and groups which
have permission to use them. Other users can filter files by restricted
tags, but cannot tag files with them or rename them. The tags are
marked (restricted)
Invisible Visible only to ownCloud admins
When you use the Tag filter on your Files page you’ll see something like the following
image. If you do not have Admin rights then you will not see any invisible tags.
Its main purpose is to encrypt files on remote storage services that are connected to
your ownCloud server, such as Dropbox and Google Drive. This is an easy and
seamless way to protect your files on remote storage. You can share your remote files
through ownCloud in the usual way, however you cannot share your encrypted files
directly from Dropbox, Google Drive, or whatever remote service you are using,
because the encryption keys are stored on your ownCloud server, and are never
exposed to outside service providers.
If your ownCloud server is not connected to any remote storage services, then it is
better to use some other form of encryption such as file-level or whole disk encryption.
Because the keys are kept on your ownCloud server, it is possible for your ownCloud
admin to snoop in your files, and if the server is compromised the intruder may get
access to your files. (Read How ownCloud uses encryption to protect your data to
learn more.)
Using Encryption
ownCloud encryption is pretty much set it and forget it, but you have a few options you
can use.
When you log back in it takes a few minutes to work, depending on how many files you
have, and then you are returned to your default ownCloud page.
You must never lose your ownCloud password, because you will lose
Share owners may need to re-share files after encryption is enabled; users trying to
access the share will see a message advising them to ask the share owner to re-share
the file with them. For individual shares, un-share and re-share the file. For group
shares, share with any individuals who can’t access the share. This updates the
encryption, and then the share owner can remove the individual shares.
If your ownCloud administrator has enabled the recovery key feature, you can choose
to use this feature for your account. If you enable "Password recovery" the
administrator can read your data with a special password. This feature enables the
administrator to recover your files in the event you lose your ownCloud password. If
the recovery key is not enabled, then there is no way to restore your files if you lose
your login password.
There may be other files that are not encrypted; only files that are exposed to third-
party storage providers are guaranteed to be encrypted.
This option is only available if your log-in password, but not your encryption password,
was changed by your administrator. This can occur if your ownCloud provider uses a
external user back-end (for example, LDAP) and changed your login password using
that back-end configuration. In this case, you can set your encryption password to
your new login password by providing your old and new login password. The
Encryption app works only if your login password and your encryption password are
identical.
Find your deleted files by clicking on the btn:[Deleted files] button on the Files page of
the ownCloud Web interface. You’ll have options to either restore or permanently
delete files.
Quotas
Deleted files are not counted against your storage quota. Only files that originate with
users count against their quotas, not files shared with them that originate from other
users. (See webgui/quota to learn more about quotas.)
When User1 deletes "sub" then it is moved to User1’s trash bin. It is deleted from
User2 and User3, but not placed in their trash bins.
When you share files, other users may copy, rename, move, and share them with other
people, just as they can for any computer files; ownCloud does not have magic powers
to prevent this.
ownCloud checks the age of deleted files every time new files are added to the deleted
files. By default, deleted files stay in the trash bin for 180 days. The ownCloud server
administrator can adjust this value in the config.php file by setting the
trashbin_retention_obligation value. Files older than the trashbin_retention_obligation
value will be deleted permanently. Additionally, ownCloud calculates the maximum
available space every time a new file is added. If the deleted files exceed the new
maximum allowed space ownCloud will expire old deleted files until the limit is met
once again.
As of ownCloud version 10.0.2 you can create Drop Folders, where users can upload
As with other shares, provide the name in the "Link Name" field, and fill out the
options that suit what you want the link to support. You can find details of what each
option does below.
Setting Description
Download / Allows recipients to view or download the public link’s contents.
View
Download / Allows recipients to view, download, edit, and delete the public link’s
View / Edit contents.
Download / Allows recipients to view, download and upload the public link’s
View / Upload contents.
Say we have three users: James, Mary, and Paul. James has a folder (Majorca-Holiday-
Pics) which he shares with Mary, who’s on a separate ownCloud instance. Mary, in
turn, (re)shares the folder with Paul, who’s on the same ownCloud instance as Mary.
You might think that there are two — even three — copies of the shared folder. In
reality, there’s only one. In effect there are three — all owned by the original sharer
(James).
The key point to keep in mind is that when a share is re-shared, it’s shared, internally,
on behalf of the original owner. To keep track of all this, during the share process
references are created between the shares, that show:
1. Go to your menu:Files[] page and click the btn:[share] icon on the file or directory
you want to share. In the sidebar enter the username and URL of the remote user
in this form: <username>@<oc-server-url>. In this example, that is layla@remote-
server/owncloud. The form automatically echoes the address that you type and
labels it as "remote". Click on the label.
Click the Share button anytime to see who you have shared your file with. Remove
your linked share anytime by clicking the trash can icon. This only unlinks the share,
and does not delete any files.
What if you do not know the username or URL? Then you can have ownCloud create
the link for you and email it to your recipient.
When your recipient receives your email they will have to take a number of steps to
complete the share link. First they must open the link you sent them in a Web browser,
and then click the btn:[Add to your ownCloud] button.
The Add to your ownCloud button changes to a form field, and your recipient needs
to enter the URL of their ownCloud server in this field and press the return key, or
click the arrow.
Remove your linked share anytime by clicking the btn:[trash can] icon. This only
unlinks the share, and does not delete any files.
Session Management
Introduction
The personal settings page allows you to have an overview of the connected browsers
and clients. It is accessed by selecting the menu:Settings[Personal > Security].
Sessions
The sessions list shows which browsers and clients were recently, and are actively
connected to your ownCloud installation. You can use the trash icon, at the far right-
hand side of any session, to terminate it.
1. If you want to lock out a user, you need to change their password before you
terminate their session.
2. The currently logged-in user cannot terminate their own session from the sessions
list.
App Passswords
44 | Session Management
Underneath the "App passwords / tokens" list is a button to create a new app or
device-specific username and password. The username will be pre-filled to the
currently logged in user, and a random password will be generated. You can change
both of these, if so desired. When you’re happy with the username and password, click
the btn:[done] button. You can use the trash icon, at the far right-hand side of any
password, to delete it
We recommend that you generate tokens for every device you want to
connect to your ownCloud instance, as this will allow you to disconnect
connections individually, if necessary.
Version Control
ownCloud supports simple version control system for files. Versioning creates backups
of files which are accessible via the Versions tab on the Details sidebar. This tab
contains the history of the file where you can roll back a file to any previous version.
Changes made at intervals greater than two minutes are saved in data/[user]/versions.
Version Control | 45
To restore a specific version of a file, click the btn:[circular arrow] to the left. Click on
the btn:[timestamp] to download it.
The versioning app expires old versions automatically to make sure that the user
doesn’t run out of space. This pattern is used to delete old versions:
The versions are adjusted along this pattern every time a new version gets created.
The version app never uses more that 50% of the user’s currently available free space.
If the stored versions exceed this limit, ownCloud deletes the oldest versions until it
meets the disk space limit again.
Storage Quotas
Introduction
Your ownCloud admin has the option to set a storage quota on users. Look at the top of
your Personal page to see what your quota is, and how much you have used.
When other users share files with you, the shared files count against the original share
owner’s quota. When you share a folder and allow other users or groups to upload files
to it, all uploaded and edited files count against your quota. When you re-share files
shared with you, the re-share still counts against the quota of the original share owner.
Encrypted files are a little larger than unencrypted files; the unencrypted size is
calculated against your quota. Deleted files that are still in the trash bin do not count
against quotas. The trash bin is set at 50% of quota. Deleted file aging is set at 30
days. When deleted files exceed 50% of quota then the oldest files are removed until
the total is below 50%.
When version control is enabled, the older file versions are not counted against
quotas. If you create a public share via URL, and allow uploads, any uploaded files
count against your quota.
46 | Storage Quotas
Why? Well, say that a user’s Trash bin contains one or more files. The user uploads
several files and in the process reaches their quota limit.
If hard quotas were enforced, the user would be prevented from being able to restore
any deleted file. However, with the Trash bin exception in place, files can always be
restored, but no new files can be uploaded, once a quota has been reached.
This user workflow may sound peculiar, but not allowing a user to restore files would
make for a poor user experience. Given that, this exception is allowed.
External Storage
Configuring External Storage
The External Storage application allows you to mount external storage services, such
as Google Drive, Dropbox, Amazon S3, SMB/CIFS fileservers, and FTP servers in
ownCloud. Your ownCloud server administrator controls which of these are available
to you. Please see Configuring External Storage (GUI) in the ownCloud Administrator’s
manual for configuration howtos and examples.
There is one difference, and that is ownCloud sharing is intentionally disabled for
SharePoint mountpoints in order to preserve SharePoint access controls, and to ensure
that content is properly accessed as per SharePoint rules. Your ownCloud admin may
optionally allow users to mount their own SharePoint libraries.
Your ownCloud admin has the option to configure SharePoint credentials so that you
are authenticated automatically, or you may be required to enter your credentials. If
you have to enter your credentials, click the btn:[red bar] and you’ll get a login
window. You should only have to do this once, as ownCloud will store your credentials.
If your SharePoint login ever changes, go to your Personal page to update it in the
Sharepoint Personal Configuration section.
Personal Page
You can manage your SharePoint connections in the Sharepoint Personal Configuration
section of your ownCloud Personal page. You’ll see two sections: the Admin added
mount points section lists SharePoint mounts controlled by your ownCloud admin. If
users have permissions to mount their own SharePoint libraries you’ll also see a
Personal mount points section.
There are two types of authentication available to you. If you have multiple SharePoint
External Storage | 47
libraries that use the same authentication, enter your credentials in Sharepoint
Personal Configuration. Then follow these steps to add your libraries:
• Enter the name of your local mountpoint in the Local Folder Name column.
• Enter your SharePoint server URL.
• Click the little refresh icon to the left of the Document Library field. If your
credentials and URL are correct you’ll get a dropdown list of SharePoint libraries to
choose from.
• Select the document library you want to mount.
• Select "Use user credentials".
• Click the btn:[Save] button, and you’re done
You may elect to use different authentication credentials for some of your SharePoint
libraries. For these, you must first select use custom credentials, and then fill in the
mountpoint and SharePoint site URL. Then ownCloud can authenticate you, and you
can click the btn:[refresh] icon to see your libraries. Then select the library you want
to mount and click the btn:[Save] button.
The ownCloud Desktop Sync Client enables you to connect to your private ownCloud
Server. You can create folders in your home directory, and keep the contents of those
folders synced with your ownCloud server. Simply copy a file into the directory and the
ownCloud desktop client does the rest. Make a change to the files on one computer, it
will flow across the others using these desktop sync clients. You will always have your
latest files with you wherever you are.
Mobile Clients
Visit your Personal page in your ownCloud Web interface to find download links for
Android and iOS mobile sync clients. Or, visit the ownCloud download page.
Visit the ownCloud documentation page to read the mobile apps user manuals.
Apps
Gallery App
Introduction
The Pictures app has been rewritten and improved, and is now called the Gallery app.
It supports more image formats, sorting, zoom, and scrolling. It also supports
advanced customizations via a simple text file.
On your main ownCloud Files page, click the little icon at the top right, underneath
your username, to open your Gallery. The Gallery app automatically finds all images in
your ownCloud folders, and overlays the thumbnails with the folder names. Click on
the folder thumbnails to open the folders. At the top left you have two sorting options,
After entering any folder, click on any image to open it in slideshow mode. This has the
following features: a download button at the top center, forward and back buttons at
the right and left sides, an automatic slideshow button at the bottom right, and a close
button at the top right.
Gallery App | 49
Custom Configuration
You may customize a Gallery album with a simple text file named gallery.cnf, which
contains parameters structured using the Yaml markup language. You may have
multiple gallery.cnf files; you need one in your own root ownCloud folder (your Home
folder) that defines global features, and then you may have individual per-album
gallery.cnf files if you want to define different behaviors in different albums.
Features
• Showing a button which lets you pick which background, either black or white, to
use for the picture you are currently viewing (for images with transparent
backgrounds).
50 | Gallery App
Setup
The configuration file has to be named gallery.cnf. You may have multiple per-album
gallery.cnf files. To enable global features, place one in your top-level folder, which is
symbolised in the Web GUI by the home icon. (This puts it in data/<user>/files/.) See
an example below in the Global features section.
You need to refresh your browser after changing your configuration to see your
changes.
Format
UTF-8, without BOM. A file created from within the ownCloud Web GUI works.
Structure
You should include a comment in the file, so that people stumbling upon the file know
what it’s for. Comments start with #.
Take a look at the YAML Format documentation if you are getting error messages.
features
external_shares: yes native_svg: yes background_colour_toggle: yes
design
background: #ff9f00 inherit: yes
information
description: This is an album description which is only shown if there is no
description_link description_ readme.md copyright: Copyright 2003-2016
[interfaSys sàrl](http://www.interfasys.ch), Switzerland copyright_ copyright.md
inherit: yes
sorting
type: date order: des inherit: yes
Supported Variables
Global Features
Place this in your root ownCloud folder, which is your Home folder.
• external_shares: Set to yes in your root configuration file if you want to load
images stored on external locations, when using the files_external app.
• native_svg: Set to yes in your root configuration file to enable rendering SVG
images in your browser. This may represent a security risk if you can’t fully trust
your SVG files.
• background_colour_toggle: Set to yes in your root configuration file to enable a
button that toggles between black and white backgrounds on transparent images.
External shares are 20-50 times slower than local shares. Be prepared to wait a long
Gallery App | 51
time before being able to see all the images contained in a shared album.
Album Configuration
Each album can be individually configured using the following configuration sections.
Use the inherit parameter to pass configurations on to sub-albums.
Design
• background: Defines the colour of the background of the photowall using the RGB
hexadecimal representation of that colour. For example: #ffa033. You must use
quotes around the value or it will be ignored. It is strongly recommended to use a
custom theme, with a CSS loading spinner if you intend to use this feature. You can
use this colour wheel to find a colour you like.
• inherit: Set to yes if you want sub-folders to inherit this part of the configuration.
Album Presentation
Do not add links to your copyright string if you use the copyright_link variable.
Sorting
Notes
• When only the sort type variable has been set, the default sort order will be used.
• When only the sort order variable has been found, the sort configuration will be
ignored and the script will keep looking for a valid configuration in upper folders.
• To enable a feature such as native SVG in a public share, you need to create in that
folder a configuration file containing that feature.
• If you share a folder publicly, don’t forget to add all the files you link to (e.g.
description.md or copyright.md) inside the shared folder as the user won’t have
access to files stored in the parent folder.
• Since people can download a whole folder as an archive, it’s usually best to include
all files within a shared folder, rather than adding text directly in the configuration
file.
Examples
Sorting Only
52 | Gallery App
# Gallery configuration file
sorting:
type: date
order: asc
Short description and link to copyright document, applies to the current folder and all
of its sub-folders. This also shows you the syntax you can use to spread a description
over multiple lines:
You can add standard configuration items to the same configuration file:
You can add standard configuration items to the same configuration file:
Synchronisation Clients
iOS - Synchronize iPhone/iPad
Calendar
1. Open the settings application.
2. Select menu:Mail[Contacts > Calendars].
3. Select btn:[Add Account].
4. Select btn:[Other] as account type.
5. Select btn:[Add CalDAV] account.
6. For server, type example.com/remote.php/dav/principals/users/USERNAME/
7. Enter your user name and password.
8. Select Next.
9. If your server does not support SSL, a warning will be displayed. Select
btn:[Continue].
10. If the iPhone is unable to verify the account information perform the following
steps:
◦ Select btn:[OK].
◦ Select btn:[Advanced Settings].
◦ If your server does not support SSL, make sure Use SSL is set to OFF.
◦ Change port to 80.
◦ Go back to account information and click btn:[Save].
Address book
1. Open the settings application.
2. Select menu:Mail[Contacts > Calendars].
3. Select btn:[Add Account].
4. Select Other as account type.
5. Select btn:[Add CardDAV] account.
6. For server, type example.com/remote.php/dav/principals/users/USERNAME/
7. Enter your user name and password.
8. Select Next.
9. If your server does not support SSL, a warning will be displayed. Select
btn:[Continue].
10. If the iPhone is unable to verify the account information perform the following:
◦ Select btn:[OK].
◦ Select advanced settings.
Now should now find your contacts in the address book of your iPhone. If it’s still not
working, have a look at the Troubleshooting Contacts & Calendar guides.
From KDE SC 4.8 and forward setting up ownCloud is very easy. Note that the KDE
calendar needs to have the ownCloud Calendar and Contacts apps enabled on the
ownCloud server. You need both and not just the Calendar. From System Settings
Personal Information/Akonadi Resources Configuration select DAV Groupware
resource.
Enter the host name and installation path. If you do not use SSL remember to de-
select "Use secure connection".
Test the connection. If everything went well you should see a message like the one
below.
Now you should see the Akonadi resource doing the first synchronization.
You can find the Contacts and Calendars in Kontact (or KOrganizer/KAddressbook if
you run the programs separately.)
Synchronizing with OS X
To use ownCloud with iCal you will need to use the following URL:
https://example.com/remote.php/dav/principals/users/USERNAME/
The setup is basically the same as with iOS using the path
Synchronizing with OS X | 57
https://example.com/remote.php/dav/principals/users/USERNAME/ to sync with
ownCloud. For OS X 10.7 Lion and 10.8 Mountain Lion everything works fine, but OS
X 10.6 (Snow Leopard) and older needs some fiddling to work. A user contributed the
following:
1. Make sure, addressbook is not running. If it is, select the windows and press
kbd:[Command+Q] to terminate it.
2. Navigate to menu:Users[YOUR_USERNAME > Library > Application Support >
AddressBook > Sources]. If you already have some kind of addressbook setup, it is
likely you will see some folders named like this BEA92826-FBF3-4E53-B5C6-
ED7C2B454430. Note down what folders there are now and leave the window
open.
3. Open addressbook and try to add a new CardDav addressbook. At this point, it does
not matter what information you enter. It will come up with the same error message
you mentioned before when you click btn:[Create]. Ignore it and click btn:[Create]
again. A non-functional addressbook will be added.
4. Close addressbook again using kbd:[Command+Q]
5. Go back to the folder window from step 2. You will now see a newly created folder
with another long string as its name.
6. Navigate to the newly created folder and edit the Configuration.plist with your
favorite text editor.
7. Search for a section looking like this:
<key>servername</key> <string>https://:0(null)</string>
<key>username</key> <string>Whatever_you_entered_before</string>
8. Make it look like this. Please note that the :443 after example.com is important:
<key>servername</key
<string>https://example.com:443/owncloud/remote.php/dav/principals/users/US
ERNAME</string> <key>username</key <string>username</string>
9. Save the file and open addressbook again. It will not work yet.
10. Open the preferences for your ownCloud CardDAV-Account and enter your
password.
11. You may have to restart addressbook once more. After this, it should work.
If it’s still not working, have a look at the Troubleshooting Contacts & Calendar
guides.
With an installed Thunderbird mail tool, an installed SoGo Connector, and an installed
Lightning add-on:
in the -bottom left- of the Contacts View (same symbol as found in the -top right- in the
Calendar view). Then look for a little impeller symbol
which will display the URL you need for your installation to work.
Once installed, synchronize (right click on your newly made remote address book and
select btn:[Synchronize]). You’ll see your address book populate from ownCloud!
Don’t click btn:[read only] above unless you don’t want to modify your ownCloud
server addressbook, like it contains a listing of corporate contacts and is shared with
lots of people, and you don’t want a new user dragging it somewhere unintended.
The rest of the details of dealing with Thunderbird addressbook are left to the
reader… First thing I learned is dragging a contact to a different addressbook is a
move operation. If you are worried about losing the contact, save it to a VCF file using
ownCloud (Or LDIF using Thunderbird Addressbook) first! Like dragging from the
ownCloud Addressbook to the Personal Address Book removes the contact from
ownCloud Server (deleting it from all the other synchronized installations) and puts it
in your Local Machine -only-Address Book. So be careful or you’ll have unintended
consequences where you might have intended a copy operation.
Troubleshooting
Troubleshooting | 59
Troubleshooting
General Troubleshooting
This section contains a list of error messages that ownCloud displays when things go
wrong. For each message, you can find the most likely cause, a resolution, and one or
more translations.
60 | Troubleshooting
Translation Das Weiterverteilen ist nicht erlaubt
File Troubleshooting
Listed here are the most common errors you may encounter while attempting to
upload files, along with what they mean, and possible workarounds.
Error while copying file to target location (copied bytes: xxx, expected
filesize: yyy)
This error is most likely due to an issue with the target storage location. During file
uploads the file data is read from PHP input and copied into a part file on the target
storage.
If the target storage is not local (eg: FTP) and that storage is slow, not available, or
broken it is likely that the operation will fail either at the beginning, or in the middle of
the copy. Other reasons for this message can be that, when writing to external storage,
the connection took too long to respond or the network connection was flaky.
Sharing sidebar does not show Shared with you by … for remote shares
In some scenarios, when users share folders and files with each other they cannot be
scanned. There are a variety of reasons why this happens, which can include firewalls
and broken servers.
In these situations, when the initial scan did not complete successfully, the mount
Troubleshooting | 61
point cannot appear in the ownCloud web UI. This is because ownCloud was not able
to generate a matching file cache entry, nor retrieve any metadata about whether it’s a
folder or file (mime type), etc.
PIM Troubleshooting
BlackBerry OS up to 10.2.2102 does not accept a URL with protocol https:// in front of
the server address. It will always tell you that it cannot login on your server. So
instead of writing:
https://example.com/remote.php/dav/principals/users/USERNAME/
example.com/remote.php/dav/principals/users/USERNAME/
62 | Troubleshooting