diff --git a/admin_manual/auth_ldap.rst b/admin_manual/configuration/auth_ldap.rst similarity index 93% rename from admin_manual/auth_ldap.rst rename to admin_manual/configuration/auth_ldap.rst index d1288d73e..9d3ad7d43 100644 --- a/admin_manual/auth_ldap.rst +++ b/admin_manual/configuration/auth_ldap.rst @@ -22,7 +22,7 @@ custom requirements you want to have a look on the advanced settings afterwards. The basic part allows you to set up a working connection to your LDAP server and use it with ownCloud. -.. figure:: images/ldap-basic-settings-oc451.png +.. figure:: ../images/ldap-basic-settings-oc451.png LDAP Basic Settings @@ -35,7 +35,7 @@ Settings Details Host: The host name of the LDAP server. It can also be a ``ldaps://`` URI, for - instance. + instance. * *Example: directory.my-company.com* @@ -60,7 +60,7 @@ Password: User Login Filter: The filter to use when a users tries to login. Use ``%uid`` as placeholder for the user name. Note, that login applies this filter only, but not User - List Filter. This may change in future. + List Filter. This may change in future. * Example (allows login with user name and email address): ``(|(uid=%uid)(email=$uid))`` @@ -83,7 +83,7 @@ common to set. They are not needed for a working connection, unless you use a non-standard Port, e.g. It can also have a positive effect on the performance to specify distinguished bases for user and group searches. -.. figure:: images/ldap-advanced-settings-oc451.png +.. figure:: ../images/ldap-advanced-settings-oc451.png LDAP Advanced Settings @@ -116,7 +116,7 @@ Use TLS: * Example: [ ] -Case insensitive LDAP server (Windows): +Case insensitive LDAP server (Windows): Wether the LDAP server is running on a Windows Host * Example: [ ] @@ -127,9 +127,9 @@ Turn off SSL certificate validation: * Example: [ ] -User Display Name Field: +User Display Name Field: The attribute that should be used as ownCloud user name. ownCloud allows - a limited set of characters ``(a-zA-Z0-9.-_@)``, every other character + a limited set of characters ``(a-zA-Z0-9.-_@)``, every other character will be replaced in ownCloud. Once a user name is assigned, it will not be changed, i.e. changing this value will only have effect to new LDAP users. The default, uid, does not exist in AD, switch to ``cn``, for example, @@ -137,24 +137,24 @@ User Display Name Field: * Example: displayName -Group Display Name Field: +Group Display Name Field: The attribute that should be used as ownCloud group name. ownCloud allows a limited set of characters (a-zA-Z0-9.-_@), every other character will be replaced in ownCloud. Once a group name is assigned, it will not be changed, i.e. changing this value will only have effect to new LDAP groups. - * Example: ``cn`` + * Example: ``cn`` -Quota Attribute: +Quota Attribute: ownCloud can read an LDAP attribute and set the user quota there from. Specify the attribute here, otherwise keep it empty. * Example: ownCloudQuota * formerly Quota Field in ownCloud 4.0 -Quota Default: - Override ownCloud default quota for LDAP users who do not - have a quota set in the attribute given above. +Quota Default: + Override ownCloud default quota for LDAP users who do not + have a quota set in the attribute given above. * Example: 15 GB @@ -169,7 +169,7 @@ Cache Time-To-Live: for example lookups check whether the users exists on every page request or WebDAV interaction. It is also supposed to speed up the Admin → User page or list of users to share with, once it is populated. Changing this setting - empties the Cache. The time is given in seconds. + empties the Cache. The time is given in seconds. * Example (10 min): 600 @@ -181,7 +181,7 @@ User Home Folder Naming Rule: i.e. changing this value will only have effect to new LDAP users. Leave it empty to default behaviour - * Example: cn + * Example: cn Microsoft Active Directory -------------------------- @@ -201,7 +201,7 @@ given in the input fields. You do not need to save before testing. By clicking on the button, ownCloud will try to bind to the ownCloud server with the settings currently given in the input fields. The response will look like this: -.. figure:: images/ldap-settings-invalid-oc45.png +.. figure:: ../images/ldap-settings-invalid-oc45.png Failure @@ -210,9 +210,9 @@ is in the data directory and called ``owncloud.log`` or on the bottom the ``Settings → Admin page``. Unfortunately it requires a reload – sorry for the inconvenience. -.. figure:: images/ldap-settings-valid-oc45.png +.. figure:: ../images/ldap-settings-valid-oc45.png - Success + Success In this case, Save the settings. You can check if the users and groups are fetched correctly on the Settings → Users page. diff --git a/admin_manual/custom_mount_config.rst b/admin_manual/configuration/custom_mount_config.rst similarity index 100% rename from admin_manual/custom_mount_config.rst rename to admin_manual/configuration/custom_mount_config.rst diff --git a/admin_manual/custom_user_backend.rst b/admin_manual/configuration/custom_user_backend.rst similarity index 100% rename from admin_manual/custom_user_backend.rst rename to admin_manual/configuration/custom_user_backend.rst diff --git a/admin_manual/configuration/index.rst b/admin_manual/configuration/index.rst index 547a3fca3..04e367107 100644 --- a/admin_manual/configuration/index.rst +++ b/admin_manual/configuration/index.rst @@ -12,3 +12,7 @@ Configuration configuration_knowledgebase configuration_logging configuration_mail + custom_mount_config + custom_user_backend + auth_ldap + xsendfile diff --git a/admin_manual/xsendfile.rst b/admin_manual/configuration/xsendfile.rst similarity index 66% rename from admin_manual/xsendfile.rst rename to admin_manual/configuration/xsendfile.rst index 604e22f28..7c64c2c05 100644 --- a/admin_manual/xsendfile.rst +++ b/admin_manual/configuration/xsendfile.rst @@ -1,31 +1,30 @@ Serving static files via web server =================================== Since ownCloud 5 it is possible to let web servers handle static file serving. -This should generally improve performance of static files serving (web servers are -optimized for this) and in some cases permits controlled file serving (i.e. pause +This should generally improve performance (web servers are optimized for this) and in some cases permits controlled file serving (i.e. pause and resume downloads). -.. note :: Notice that currently this feature can be activated only for local files, i.e. files inside data directory and local mounts. Controlled file serving does not work for generated zip files. This is due to how temporary files are created. Also it has **never been tested under lighttpd** but its configuration should be the same as Apache +.. note :: This feature can currently only be activated for local files, i.e. files inside the **data/** directory and local mounts. Controlled file serving **does not work for generated zip files**. This is due to how temporary files are created. Also it has **never been tested under lighttpd** but its configuration should be the same as Apache Apache2 (X-Sendfile) -------------------- It is possible to let Apache handle static file serving via `mod_xsendfile `_. -**Installation:** +Installation +~~~~~~~~~~~~ +On Debian and Ubuntu systems use: -On Debian and Ubuntu systems that is +.. code-block:: bash -:: - apt-get install libapache2-mod-xsendfile -**Configuration:** - -Configuration of mod_xsendfile for ownCloud depends on its version. +Configuration +~~~~~~~~~~~~~ +Configuration of mod_xsendfile for ownCloud depends on its version. For versions below 0.10 (Debian squeeze ships with 0.9) -:: +.. code-block:: xml ... @@ -36,7 +35,7 @@ For versions below 0.10 (Debian squeeze ships with 0.9) For versions >=0.10 (e.g. Ubuntu 12.10) -:: +.. code-block:: xml ... @@ -54,17 +53,15 @@ For versions >=0.10 (e.g. Ubuntu 12.10) Nginx (X-Accel-Redirect) ------------------------ -Nginx supports handling of static files differently from Apache. Documentation can be found `here`__ and `here`__. The header used by Nginx is X-Accel-Redirect. - -**Installation:** +Nginx supports handling of static files differently from Apache. Documentation can be found in the Nginx Wiki section `Mod X-Sendfile `_ and section `X-Accell `_. The header used by Nginx is X-Accel-Redirect. +Installation +~~~~~~~~~~~~ X-Accel-Redirect is supported by default in Nginx and no additional operation should be needed to install it. -**Configuration:** - -Configuration is similar to Apache - -:: +Configuration +~~~~~~~~~~~~~ +Configuration is similar to Apache:: location ~ \.php$ { ... @@ -83,15 +80,13 @@ Configuration is similar to Apache * **fastcgi_param MOD_X_ACCEL_REDIRECT_ENABLED:** tells ownCloud scripts that they should add the X-Accel-Redirect header when serving files -* **internal location:** each directory that contains local user data should correspond to an internal location. In the example I have data inside: - #. /home/valerio/owncloud/data: ownCloud data directory - #. /home/valerio/data: a local mount - #. /tmp/oc-noclean: PHP temporary directory concatenated with *oc-noclean*. Temporary zip files will be created inside this directory when using X-Accel-Redirect +* **internal location:** each directory that contains local user data should correspond to an internal location. In the example uses the following directories: -How do I know it's working? ---------------------------- -You are still able to download stuff via the web interface and single, local file downloads can be paused and resumed :-). + * **/home/valerio/owncloud/data**: ownCloud data directory + * **/home/valerio/data**: a local mount + * **/tmp/oc-noclean**: PHP temporary directory concatenated with *oc-noclean*. Temporary zip files will be created inside this directory when using X-Accel-Redirect -__ http://wiki.nginx.org/XSendfile -__ http://wiki.nginx.org/X-accel +How to check if it's working? +----------------------------- +You are still able to download stuff via the web interface and single, local file downloads can be paused and resumed. diff --git a/admin_manual/contents.rst b/admin_manual/contents.rst index 04e0818ac..06485d98a 100644 --- a/admin_manual/contents.rst +++ b/admin_manual/contents.rst @@ -14,14 +14,7 @@ ownCloud documentation contents installation/index configuration/index - custom_mount_config - custom_user_backend - migrating - update - xsendfile - auth_ldap - - + maintenance/index Indices and tables ================== diff --git a/admin_manual/index.rst b/admin_manual/index.rst index b4605a393..eaddf9cfd 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -48,6 +48,26 @@ If you want to just try ownCloud in a virtual machine without any configuration, * :doc:`installation/installation_source` * :doc:`installation/installation_others` +Configuration +============= +* :doc:`configuration/configuration_3rdparty` +* :doc:`configuration/configuration_apps` +* :doc:`configuration/configuration_automation` +* :doc:`configuration/configuration_database` +* :doc:`configuration/configuration_knowledgebase` +* :doc:`configuration/configuration_logging` +* :doc:`configuration/configuration_mail` +* :doc:`configuration/custom_mount_config` +* :doc:`configuration/custom_user_backend` +* :doc:`configuration/auth_ldap` +* :doc:`configuration/xsendfile` + +Maintenance +=========== +* :doc:`maintenance/migrating` +* :doc:`maintenance/update` + + Indices and tables ================== diff --git a/admin_manual/maintenance/index.rst b/admin_manual/maintenance/index.rst new file mode 100644 index 000000000..71a06d3fb --- /dev/null +++ b/admin_manual/maintenance/index.rst @@ -0,0 +1,9 @@ +=========== +Maintenance +=========== + +.. toctree:: + :maxdepth: 1 + + migrating + update \ No newline at end of file diff --git a/admin_manual/migrating.rst b/admin_manual/maintenance/migrating.rst similarity index 100% rename from admin_manual/migrating.rst rename to admin_manual/maintenance/migrating.rst diff --git a/admin_manual/update.rst b/admin_manual/maintenance/update.rst similarity index 97% rename from admin_manual/update.rst rename to admin_manual/maintenance/update.rst index f8acf4b0c..f69178856 100644 --- a/admin_manual/update.rst +++ b/admin_manual/maintenance/update.rst @@ -26,7 +26,7 @@ Download the latest version to the working directory: ``wget http://mirrors.owncloud.org/releases/owncloud-latest.tar.bz2`` -Extract content of archive to ``./owncloud_latest/``. +Extract content of archive to ``./owncloud_latest/``. ``mkdir owncloud_latest; tar -C owncloud_latest -xjf owncloud-latest.tar.bz2`` @@ -65,4 +65,3 @@ If so, install and enable them, update procedures will run if needed. 9. If you installed ownCloud from a repository, your package management should take care of it. Probably you will need to look for compatible third party applications yourself. Always do backups anyway. -