cleanups and markup corrections

This commit is contained in:
Carla Schroder
2015-09-23 05:07:37 -07:00
parent ef57afa3d8
commit f5ab7cbaca
13 changed files with 140 additions and 121 deletions

View File

@@ -126,7 +126,7 @@ You and your users can encrypt individual external mountpoints. You must have
external storage enabled on your Admin page, and enabled for your users.
Encryption settings can be configured in the mount options for an external
storage mount, see :ref:`external_storage_mount_options`
storage mount, see :ref:`external_storage_mount_options_label`
(:doc:`external_storage_configuration_gui`)
Enabling Users' File Recovery Key

View File

@@ -18,11 +18,12 @@ The ``Enable SSL`` checkbox enables HTTPS connections; using HTTPS is always
highly-recommended.
.. figure:: images/amazons3.png
:alt:
Optionally, you can override the hostname, port and region of your S3 server,
which is required for non-Amazon servers such as Ceph Object Gateway.
``Enable path style`` is usually not required (and is, in fact, incompatible
**Enable path style** is usually not required (and is, in fact, incompatible
with newer Amazon datacenters), but can be used with non-Amazon servers where
the DNS infrastructure cannot be controlled. Ordinarily, requests will be
made with ``http://bucket.hostname.domain/``, but with path style enabled,
@@ -30,3 +31,5 @@ requests are made with ``http://hostname.domain/bucket`` instead.
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

View File

@@ -1,45 +1,46 @@
===========================================
External Storage: Authentication mechanisms
===========================================
==========================================
External Storage Authentication mechanisms
==========================================
Storage backends can accept one or more authentication 'schemes', such as
passwords, OAuth, or token-based to name a few examples. Each authentication
scheme may be implemented by multiple authentication mechanisms. Different
mechanisms require different configuration parameters, depending on their
ownCloud storage backends accept one or more authentication schemes such as
passwords, OAuth, or token-based, to name a few examples. Each authentication
scheme may be implemented by multiple authentication mechanisms. Different
mechanisms require different configuration parameters, depending on their
behaviour.
Special mechanisms
Special Mechanisms
------------------
The 'None' authentication mechanism requires no configuration parameters, and
The **None** authentication mechanism requires no configuration parameters, and
is used when a backend requires no authentication.
The 'Built-in' authentication mechanism itself requires no configuration
The **Built-in** authentication mechanism itself requires no configuration
parameters, but is used as a placeholder for legacy storages that have not been
migrated to the new system and do not take advantage of generic authentication
mechanisms. The authentication parameters are provided directly by the backend.
Password-based mechanisms
Password-based Mechanisms
-------------------------
The 'Username and password' mechanism requires a manually-defined username and
The **Username and password** mechanism requires a manually-defined username and
password. These get passed directly to the backend.
The 'Session credentials' mechanism uses the ownCloud login credentials of the
The **Session credentials** mechanism uses the ownCloud login credentials of the
user to connect to the storage. These are not stored anywhere on the server,
rather in the user session, giving increased security. The drawback is that
but rather in the user session, giving increased security. The drawback is that
sharing is disabled when this mechanism is in use, as ownCloud has no access
to the storage credentials and so other users cannot use it.
Public-key mechanisms
Public-key Mechanisms
---------------------
Currently only the 'RSA' mechanism is implemented, where a public/private
Currently only the RSA mechanism is implemented, where a public/private
keypair is generated by ownCloud and the public half shown in the GUI. The keys
are generated in the SSH format, and are currently 1024 bits in length. Keys
can be regenerated with a button in the GUI.
.. figure:: images/auth_rsa.png
:alt: Form on admin page for generating RSA keys.
OAuth
-----
@@ -47,7 +48,8 @@ OAuth
OAuth 1.0 and OAuth 2.0 are both implemented, but currently limited to the
Dropbox and Google Drive backends respectively. These mechanisms require
additional configuration at the service provider, where an app ID and app
secret are provided and can be entered into ownCloud. Then, ownCloud can
secret are provided and then entered into ownCloud. Then ownCloud can
perform an authentication request, establishing the storage connection.
.. figure:: images/dropbox-oc.png
:alt: Dropbox storage mount configuration.

View File

@@ -49,4 +49,6 @@ account. Click **Allow**, and you're done.
.. figure:: images/dropbox-allowshare.png
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

View File

@@ -16,9 +16,9 @@ To connect to an FTP server, you will need:
Your new mountpoint is available to all users by default, and you may restrict
access by entering specific users or groups in the **Available for** field.
Optionally, ownCloud can use FTPS by checking **Secure ftps://**. This requires
additional configuration with you root certificate if the FTP server uses a
self-signed certificate.
Optionally, ownCloud can use FTPS (FTP over SSL) by checking **Secure ftps://**.
This requires additional configuration with your root certificate if the FTP
server uses a self-signed certificate.
.. figure:: images/ftp.png
:alt: ownCloud GUI FTP configuration.

View File

@@ -16,42 +16,43 @@ because the Google interface is a bit of a maze and it's easy to get lost.
If you already have a Google account, such as Groups, Drive, or Mail, you can
use your existing login to log into the Google Cloud Console. After logging in
click the ``Create Project`` button.
click the **Create Project** button.
.. figure:: images/google-drive.png
:alt: Google Drive app "create project" screen
Give your project a name, and either accept the default ``Project ID`` or create
your own, then click the ``Create`` button.
Give your project a name, and either accept the default **Project ID** or
create
your own, then click the **Create** button.
.. figure:: images/google-drive1.png
:alt: New project creation screen.
The next screen is your ``Project Dashboard``. The Activities screen on the
bottom left shows your current status. In the left sidebar click ``APIs
& Auth > APIs``, and then click ``Google Apps APIs > Drive API``.
The next screen is your **Project Dashboard**. The Activities screen on the
bottom left shows your current status. In the left sidebar click **APIs
& Auth > APIs**, and then click **Google Apps APIs > Drive API**.
.. figure:: images/google-drive2.png
:alt: Project dashboard, with all project options.
Before you click ``Enable API`` you might want to click on ``Learn more`` or
``Explore this API``. Then click ``Enable API``.
Before you click **Enable API** you might want to click on **Learn more** or
**Explore this API**. Then click **Enable API**.
.. figure:: images/google-drive3.png
:alt: "Enable API" button.
``Enable API`` takes you to the Drive API dashboard, with tabs for
``Overview, Usage, Quota``, and ``Drive UI Integration``. Feel free to
explore, and then go to ``APIs & Auth > Credentials``. This screen has two
sections: ``OAuth`` and ``Public API Access``.
**Enable API** takes you to the Drive API dashboard, with tabs for
**Overview, Usage, Quota**, and **Drive UI Integration**. Feel free to
explore, and then go to **APIs & Auth > Credentials**. This screen has two
sections: **OAuth** and **Public API Access**.
.. figure:: images/google-drive4.png
:alt: API dashboard.
Click ``OAuth > Create New Client ID``. The next screen that opens is ``Create
Client ID``. Check ``Web Application`` and click the ``Configure Consent
Screen`` button. You'll see the consent screen the first time you create a
Click **OAuth > Create New Client ID**. The next screen that opens is **Create
Client ID**. Check **Web Application** and click the **Configure Consent
Screen** button. You'll see the consent screen the first time you create a
mountpoint for your Google Drive in ownCloud.
.. figure:: images/google-drive5.png
@@ -61,41 +62,44 @@ There are just a few required fields on the Consent Screen form: the email
address of your Google account and your app name. The optional fields include
your site URL, a link to your logo, and links to your privacy and terms of
service policies. Your logo must be a hosted file because there is no upload
dialogue. Click ``Save`` when you're finished.
dialogue. Click **Save** when you're finished.
.. figure:: images/google-drive6.png
:alt: Consent screen.
Now you should be on the ``Edit Client Settings`` screen. The ``Authorized
JavaScript Origins`` is your root domain, for example
``https://www.example.com``. You need two ``Authorized Redirect URIs``, which
Now you should be on the **Edit Client Settings** screen. The **Authorized
JavaScript Origins** is your root domain, for example
``https://www.example.com``. You need two **Authorized Redirect URIs**, which
must be in the following form::
https://example.com/owncloud/index.php/settings/personal
https://example.com/owncloud/index.php/settings/admin
Replace ``https://example.com/owncloud/`` with your own ownCloud server URL,
then click ``Save``.
then click **Save**.
.. figure:: images/google-drive10.png
:alt: Edit Client Settings screen
This should take you back to the OAuth screen, with a summary of your settings
and editing buttons. This contains your ``Client ID`` and ``Client Secret``,
and editing buttons. This contains your **Client ID** and **Client Secret**,
which you need to set up your ownCloud connection.
.. figure:: images/google-drive11.png
:alt: OAuth screen
Go to your ``Admin`` page in ownCloud, create your new folder name, enter the
Client ID and Client Secret, select your users and groups, and click ``Grant
Access``.
Go to your Admin page in ownCloud, create your new folder name, enter the
Client ID and Client Secret, select your users and groups, and click **Grant
Access**.
.. figure:: images/google-drive8.png
:alt: Google Drive configuration on ownCloud Admin page.
Google will open a dialogue asking for permission to connect to ownCloud. Click
``Accept``. When you see the green light confirming a successful connection
**Accept**. When you see the green light confirming a successful connection
you're finished.
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

View File

@@ -9,7 +9,8 @@ mounts.
Use this to mount any directory on your ownCloud server that is outside
of your ownCloud ``data/`` directory. This directory must be readable and
writable by your HTTP server user, like these examples on Ubuntu Linux::
writable by your HTTP server user. These ownership and permission examples
are on Ubuntu Linux::
sudo -u www-data chown -R www-data:www-data /localdir
sudo -u www-data chmod -R 0750 /localdir
@@ -30,3 +31,5 @@ access the mount. By default all users have access.
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

View File

@@ -10,16 +10,16 @@ storage that uses the OpenStack Swift protocol.
The bucket will be created if it does not exist.
The OpenStack authentication mechanism uses the OpenStack Keystone v2
protocol, connecting to the server specified in the ``URL of Identity
Endpoint`` field. You need your ``Username``, ``Tenant name`` and ``Password``.
protocol, connecting to the server specified in the **URL of Identity
Endpoint** field. You need your **Username**, **Tenant name** and **Password**.
The Rackspace authentication mechanism requires a Rackspace ``Username`` and
``API key``.
The Rackspace authentication mechanism requires a Rackspace **Username** and
**API key**.
It may be necessary to specify a ``Service name`` or ``Region``. The timeout of
HTTP requests is set in the ``Request timeout`` field, in seconds.
It may be necessary to specify a **Service name** or **Region**. The timeout of
HTTP requests is set in the **Request timeout** field, in seconds.
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.
See :doc:`auth_mechanisms` for more information on authentication schemes.

View File

@@ -3,10 +3,15 @@ ownCloud
========
An ownCloud storage is a specialized :doc:`webdav` storage, with optimizations
for ownCloud-ownCloud communication. See the :doc:`webdav` documentation for
how to configure an ownCloud external storage.
for ownCloud-ownCloud communication. See the :doc:`webdav` documentation to
learn how to configure an ownCloud external storage.
When filling in the ``URL`` field, put the path to the root of the ownCloud
When filling in the **URL** field, use the path to the root of the ownCloud
installation, rather than the path to the WebDAV endpoint. So, for a server at
``http://example.com/owncloud``, put ``http://example.com/owncloud``, not
``http://example.com/owncloud``, use ``http://example.com/owncloud`` and not
``http://example.com/owncloud/remote.php/webdav``.
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

View File

@@ -2,12 +2,10 @@
SFTP
====
ownCloud's SFTP backend connects to an SFTP server over an SSH tunnel. It
supports both password and public key authentication. Select **SFTP** from the
**Add Storage** dropdown menu for password authentication, and **SFTP with
secret key login** for public key authentication.
ownCloud's SFTP (FTP over an SSH tunne) backend supports both password and
public key authentication.
The ``Host`` field is required; a port can be specified as part of the ``Host``
The **Host** field is required; a port can be specified as part of the **Host**
field in the following format: ``hostname.domain:port``. The default port is 22
(SSH).
@@ -15,10 +13,11 @@ For public key authentication, you can generate a public/private key pair from
your **SFTP with secret key login** configuration.
.. figure:: images/auth_mechanism.png
:alt: Generating an RSA key pair in the SFTP configuration.
After generating your keys, you need to copy your new public key to the
destination server in ``.ssh/authorized_keys``. ownCloud will then use its
private key to connect to the SFTP server.
destination server to ``.ssh/authorized_keys``. ownCloud will then use its
private key to authenticate to the SFTP server.
The default **Remote Subfolder** is the root directory (``/``) of the remote
SFTP server, and you may enter any directory you wish.

View File

@@ -2,8 +2,8 @@
SMB/CIFS
========
ownCloud can connect to Windows file servers or other SMB compatible servers
with this backend.
ownCloud can connect to Windows file servers or other SMB-compatible servers
with the SMB/CIFS backend.
.. note:: The SMB/CIFS backend requires ``smbclient`` to be installed on the
ownCloud server. This should be included any any Linux distribution.
@@ -22,17 +22,15 @@ You need the following information:
subfolder name.
* And finally, the ownCloud users and groups who get access to the share.
Optionally, a ``Domain`` can be specified. This is useful in cases where the
Optionally, you can specify a ``Domain``. This is useful in
cases where the
SMB server requires a domain and a username, and an advanced authentication
mechanism like 'Session credentials' is used such that the username cannot be
mechanism like session credentials is used so that the username cannot be
modified. This is concatenated with the username, so the backend gets
``domain\username``
Optionally, a ``Remote subfolder`` can be specified to change the destination
directory within the share. The default is the root of the share.
.. note:: For improved reliability and performance, we recommended installing
``libsmbclient-php``, a native PHP module for connecting to
``libsmbclient-php``, a native PHP module for connecting to
SMB servers. It is available as ``php5-libsmbclient`` in the ownCloud
`OBS repositories <https://software.opensuse.org/download/package?
project=isv:ownCloud:community&package=php5-libsmbclient>`_

View File

@@ -10,7 +10,6 @@ You need the following information:
* Folder name: The name of your local mountpoint.
* The URL of the WebDAV or ownCloud server.
* Username and password for the remote server
* Remote Subfolder: Optional, defaults to /)
* Secure https://: We always recommend https:// for security, though you can
leave this unchecked for http://.
@@ -18,6 +17,7 @@ Optionally, a ``Remote Subfolder`` can be specified to change the destination
directory. The default is to use the whole root.
.. figure:: images/webdav.png
:alt: Webdav configuration form.
.. Note:: CPanel users should install `Web Disk
<https://documentation.cpanel.net/display/ALD/Web+Disk>`_ to enable WebDAV

View File

@@ -9,55 +9,56 @@ users to mount their own external storage services.
Enabling External Storage Support
---------------------------------
The ``External storage support`` application is enabled on the ``Apps`` page.
The External storage support application is enabled on your Apps page.
.. figure:: external_storage/images/enable_app.png
:alt: Enable external storage on your Apps page.
Storage configuration
Storage Configuration
---------------------
To create a new external storage mount, select an available backend from the
dropdown 'Add storage'. Each backend has different required options, which can
be configured in the 'Configuration' fields.
dropdown **Add storage**. Each backend has different required options, which
are configured in the configuration fields.
.. figure:: external_storage/images/add_storage.png
Each backend may also accept multiple authentication methods. These can be
selected with the dropdown under 'Authentication'. Different backends support
different authentication mechanisms, some specific to the backend, others more
generic. See :doc:`external_storage/auth_mechanisms` for more detailed
Each backend may also accept multiple authentication methods. These are selected
with the dropdown under **Authentication**. Different backends support different
authentication mechanisms; some specific to the backend, others are more
generic. See :doc:`external_storage/auth_mechanisms` for more detailed
information.
When an authentication mechanism is selected, the configuration fields will
change as appropriate for the mechanism. Some backends may not be migrated to
the new authentication mechanism system, and will be displayed with a mechanism
of 'Built-in'.
Here is an example of the SFTP backend, which supports both password-based
authentication and public key authentication:
When you select an authentication mechanism, the configuration
fields change as appropriate for the mechanism. Some backends are not yet
migrated to
the new authentication mechanism system, and are displayed with a mechanism
of **Built-in**. The SFTP backend, to give an example, supports both
password-based authentication and public key authentication.
.. figure:: external_storage/images/auth_mechanism.png
:alt: An SFTP configuration example.
If any required fields remain incomplete, they will be marked with a red
border. When all required fields are filled, the storage will be saved. A green
dot next to the storage row indicates the storage is ready for use, a red
square indicates an error occurred - double check your configuration settings.
A yellow icon indicates that ownCloud could not verify the storage, perhaps due
to missing information at that moment in time.
Required fields are marked with a red border. When all required fields are
filled, the storage is automatically saved. A green dot next to the storage row
indicates the storage is ready for use. A red or yellow icon indicates
that ownCloud could not connect to the external storage, so you need to
re-check your configuration and network availability.
Applicable users/groups
-----------------------
User and Group Permissions
--------------------------
A storage configured in the personal settings will be available only to the
user that created it, but a storage configured in the admin settings can be
assigned to users and groups. By default, all users are assigned the storage;
this can be restricted with the 'Available for' selection.
A storage configured in a user's Personal settings is available only to the user
that created it. A storage configured in the Admin settings is available to
all users by default, and it can be restricted to specific users and groups in
the **Available for** field.
.. figure:: external_storage/images/applicable.png
:alt: User and groups selector
.. _external_storage_mount_options:
.. _external_storage_mount_options_label:
Mount options
Mount Options
-------------
Hover your cursor to the right of any storage configuration to expose
@@ -71,13 +72,15 @@ individually with the following options:
filesystem is used)
.. figure:: external_storage/images/mount_options.png
:alt: Additional mount options exposed on mouseover.
Using self-signed certificates
Using Self-Signed Certificates
------------------------------
When using self-signed certificates for external storage mounts the certificate
needs to be imported in the personal settings of the user. Please refer to
`this blogpost <http://ownclouden.blogspot.de/2014/11/owncloud-https-external-mount.html>`_
must be imported into the personal settings of the user. Please refer to
`ownCloud HTTPS External Mount
<http://ownclouden.blogspot.de/2014/11/owncloud-https-external-mount.html>`_
for more information.
Available storage backends
@@ -103,25 +106,26 @@ may provide their own backends, which are not listed here.
.. note:: A non-blocking or correctly configured SELinux setup is needed
for these backends to work. Please refer to the :ref:`selinux-config-label`.
Configuring backends mountable by the user
------------------------------------------
Allow Users to Mount External Storage
-------------------------------------
Check ``Enable User External Storage`` to allow your users to mount their own
external storage services, and check the backends you want to allow. Beware,
this allows a user to make potentially arbitrary connections to other services
Check **Enable User External Storage** to allow your users to mount their own
external storage services, and check the backends you want to allow. Beware, as
this allows a user to make potentially arbitrary connections to other services
on your network!
.. figure:: external_storage/images/user_mounts.png
:alt: Checkboxes to allow users to mount external storage services.
Adding files to external storages
Adding Files to External Storages
---------------------------------
In general it is recommended to configure the background job ``Webcron`` or
``Cron`` as described in :doc:`../configuration_server/background_jobs_configuration`
so ownCloud is able to detect files added to your external storages without the need
for a user to be browsing your ownCloud installation.
We recommend configuring the background job **Webcron** or
**Cron** (see :doc:`../configuration_server/background_jobs_configuration`)
to enable ownCloud to automatically detect files added to your external
storages.
Please also be aware that ownCloud might not always be able to find out what has been
ownCloud may not always be able to find out what has been
changed remotely (files changed without going through ownCloud), especially
when it's very deep in the folder hierarchy of the external storage.
@@ -130,7 +134,7 @@ You might need to setup a cron job that runs ``sudo -u www-data php occ files:sc
to trigger a rescan of the user's files periodically (for example every 15 minutes), which includes
the mounted external storage.
Configuration file
Configuration File
------------------
Storage mount configurations are stored in a JSON formatted file. Admin
@@ -138,4 +142,3 @@ storages are stored in ``data/mount.json``, while personal storages are stored
in ``data/$user/mount.json``. For more advanced use cases, including
provisioning external storages from outside ownCloud, see
:doc:`external_storage_configuration`.