diff --git a/admin_manual/configuration/auth_ldap.rst b/admin_manual/configuration/auth_ldap.rst index d4c54e766..87e03ae03 100644 --- a/admin_manual/configuration/auth_ldap.rst +++ b/admin_manual/configuration/auth_ldap.rst @@ -17,13 +17,13 @@ Settings→Admin. Read on for a detailed description of the configuration fields Configuration ------------- -The LDAP backend follows a wizard-like approach, splitted into four tabs. A +The LDAP backend follows a wizard-like approach, split into four tabs. A correctly completed first tab ("Server") is mandatory to access the other tabs. Also, the other tabs need to be reviewed by the admin, however the necessary settings are detected automatically. An indicator will show whether the configuration is incomplete, incorrect or OK. -The settings are changed automatically, as soon as a input element looses the +The settings are changed automatically, as soon as a input element loses the focus, i.e. the cursor is taken away by clicking somewhere else or pressing the tabulator key. @@ -63,8 +63,8 @@ Host: Port: The port on which to connect to the LDAP server. The field is disabled in the - beginning of a new configuration. The port will be detected automatically, - if the LDAP server is running on a standard port. After ownCloud attempted to + beginning of a new configuration. If the LDAP server is running on a standard port, + the port will be detected automatically. After ownCloud attempted to determine the port, the field will be enabled for user input. A successfully found port will be inserted by ownCloud, of course. @@ -104,7 +104,7 @@ filter. .. figure:: ../images/ldap-wizard-2-user.png only those object classes: - ownCloud will determine the object classes that are typically availalble for + ownCloud will determine the object classes that are typically available for (ideally only) user objects in your LDAP. ownCloud will automatically select the object class that returns the highest amount of users. You can select multiple object classes. @@ -172,24 +172,24 @@ Edit raw filter instead: Group Filter ~~~~~~~~~~~~ -The settings in the group filter tab determine which groups will be availalble -in ownCloud. It does not have any restrictions on logins, this has been dealed +The settings in the group filter tab determine which groups will be available +in ownCloud. It does not have any restrictions on logins, this has been dealt with in the prior tabs. It is also possible to enter a raw LDAP filter. -By default, no groups will be availalble in ownCloud. You actively need to +By default, no groups will be available in ownCloud. You actively need to enable groups. .. figure:: ../images/ldap-wizard-4-group.png only those object classes: - ownCloud will determine the object classes that are typically availalble for + ownCloud will determine the object classes that are typically available for (ideally only) group objects in your LDAP. ownCloud will only list object classes that return at least one group object. You can select multiple object classes. A typical object class is "group", or "posixGroup". only from those groups: - This setting lets you pick certain groups that shall be availalble in + This setting lets you pick certain groups that shall be available in ownCloud. This field follows a whitelist approach. ownCloud will generate a list of available groups found in your LDAP server. You can select multiple groups. diff --git a/admin_manual/configuration/background_jobs.rst b/admin_manual/configuration/background_jobs.rst index 139fbf954..152a705fa 100644 --- a/admin_manual/configuration/background_jobs.rst +++ b/admin_manual/configuration/background_jobs.rst @@ -19,7 +19,7 @@ You can choose between the following options: Cron-Jobs --------- -OwnCloud requires various automated background jobs to be run. There are three methods to achieve this. +ownCloud requires various automated background jobs to be run. There are three methods to achieve this. The default way is AJAX and the recommended way is cron. AJAX @@ -54,7 +54,7 @@ may have. **Example** -To run a cron job on a \*nix system, e.g. every 15min, under the default web server +To run a cron job on a \*nix system, e.g. every 15 min., under the default web server user, e.g. **www-data**, you need to set-up the following cron job to call the **cron.php** script. Please check the crontab man page for the exact command syntax. diff --git a/admin_manual/configuration/configuration_apps.rst b/admin_manual/configuration/configuration_apps.rst index 09c16496e..67c843cbd 100644 --- a/admin_manual/configuration/configuration_apps.rst +++ b/admin_manual/configuration/configuration_apps.rst @@ -7,6 +7,7 @@ With ownCloud installation, you will find some apps enabled by default. To see w are enabled, click on Apps button on the web interface navigation to go into applications page: .. figure:: ../images/oc_admin_app_page.png + Administrator application page In this page, you can enable or disable applications simply by clicking on their names. diff --git a/admin_manual/configuration/configuration_custom_clients.rst b/admin_manual/configuration/configuration_custom_clients.rst index 88df77ed1..75f00163e 100644 --- a/admin_manual/configuration/configuration_custom_clients.rst +++ b/admin_manual/configuration/configuration_custom_clients.rst @@ -6,7 +6,7 @@ and different client sync applications. Download links which point to these applications are shown at the top of the personal menu. The following sync applications are currently available out of the box: -* Desktop sync clients for Windows, Max and Linux OS +* Desktop sync clients for Windows, MAC and Linux OS * Mobile sync client for Android devices * Mobile sync client for iOS devices diff --git a/admin_manual/configuration/configuration_database.rst b/admin_manual/configuration/configuration_database.rst index 3e4c24779..ebb8df0c3 100644 --- a/admin_manual/configuration/configuration_database.rst +++ b/admin_manual/configuration/configuration_database.rst @@ -246,11 +246,12 @@ ownCloud to config file could look like this: "dbpassword" => "password", "dbhost" => "localhost", -.. note:: This example assumes you are running an Oracle Express Edition on ``localhost``. The ``dbname`` is the name -of the Oracle instance. For Oracle Express Edition it is always ``XE``. +.. note:: This example assumes you are running an Oracle Express Edition on ``localhost``. + The ``dbname`` is the name of the Oracle instance. For Oracle Express Edition it + is always ``XE``. -Trouble Shooting ----------------- +Troubleshooting +--------------- How can I find out if my MySQL/PostgreSQL server is reachable? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/admin_manual/configuration/configuration_language.rst b/admin_manual/configuration/configuration_language.rst index 386d7d8fe..3a38bcb28 100644 --- a/admin_manual/configuration/configuration_language.rst +++ b/admin_manual/configuration/configuration_language.rst @@ -2,7 +2,7 @@ Language Configuration ====================== In normal cases ownCloud will automatically detect the language of the Web-GUI. -If this doesn't work properly or you want to make sure that ownCloud always +If this does not work properly or you want to make sure that ownCloud always starts with a given language, you can use the **default_language** parameter. Please keep in mind, that this will not effect a users language preference, diff --git a/admin_manual/configuration/configuration_mail.rst b/admin_manual/configuration/configuration_mail.rst index 3ff6b6259..5f52aa357 100644 --- a/admin_manual/configuration/configuration_mail.rst +++ b/admin_manual/configuration/configuration_mail.rst @@ -2,7 +2,7 @@ Mail Configuration ================== ownCloud does not contain a full email program but contains some parameters to allow to send e.g. password reset email to the users. This function relies on -the `PHPMailer library `_. To +the `PHPMailer library `_. To take advantage of this function it needs to be configured properly. @@ -20,7 +20,7 @@ All parameters need to be set in :file:`config/config.php` SMTP ~~~~ If you want to send email using a local or remote SMTP server it is necessary -to enter the name or ip address of the server, optionally followed by a colon +to enter the name or IP address of the server, optionally followed by a colon separated port number, e.g. **:425**. If this value is not given the default port 25/tcp will be used unless you will change that by modifying the **mail_smtpport** parameter. Multiple server can be entered separated by @@ -181,23 +181,12 @@ be able to send email out of the box. Send a Test Email ----------------- -The only way to test your email configuration is, to force a login failure, -because a function to send a test email has not be implemented yet. +To test your email configuration, save your email address in your personal +settings and then use the **Send email** button in *Email Server* section +of the Admin settings page. -First make sure that you are using a full qualified domain and not an ip address in the ownCloud URL, like:: - http://my-owncloud-server.domain.dom/owncloud/ - -The password reset function fetches the domain name from that URL to build the -email sender address, e.g.:: - - john@domain.dom - -Next you need to enter your login and an *invalid* password. As soon as you -press the login button the login mask reappears and a **I’ve forgotten my password** link will be shown above the login -field. Click on that link, re-enter your login and press the **Reset password** button - that's all. - -Trouble shooting +Troubleshooting ---------------- My web domain is different from my mail domain? @@ -310,7 +299,7 @@ Enable Debug Mode If you are still not able to send email it might be useful to activate further debug messages by setting the following parameter. Right after -you have pressed the **Reset password** button, as described before, a +you have pressed the **Send email** button, as described before, a lot of **SMTP -> get_lines(): ...** messages will be written on the screen. diff --git a/admin_manual/configuration/configuration_preview.rst b/admin_manual/configuration/configuration_preview.rst index b21710953..951215923 100644 --- a/admin_manual/configuration/configuration_preview.rst +++ b/admin_manual/configuration/configuration_preview.rst @@ -17,8 +17,8 @@ Soft dependencies: imagick: ~~~~~~~~ -ownCloud needs the imagick php extension to generate previews from office, pdf -and svg files. For further information on how to install the imagick php +ownCloud needs the imagick PHP extension to generate previews from office, PDF +and SVG files. For further information on how to install the imagick PHP extension on your system take a look at the `PHP documentation `_. If imagick is not installed, ownCloud will show file type icons instead of previews. diff --git a/admin_manual/configuration/configuring_big_file_upload.rst b/admin_manual/configuration/configuring_big_file_upload.rst index 500d6b73c..24129b9e8 100644 --- a/admin_manual/configuration/configuring_big_file_upload.rst +++ b/admin_manual/configuration/configuring_big_file_upload.rst @@ -1,6 +1,6 @@ Uploading big files > 512MB (as set by default) =============================================== -It's usefull to know limiting factors, that make it impossible to exceed the values given by the ownCloud-system: +It's useful to know limiting factors, that make it impossible to exceed the values given by the ownCloud-system: Not outnumberable upload limits: -------------------------------- @@ -14,32 +14,47 @@ Other recommendable preconditions: * Make sure, that the latest version of PHP (at least 5.4.9) is installed * Disable user quota. This means: set the user quota of the account, you are currently logged in, to "unlimited". + This is important, because you possibly could not watch otherwise, whether the desired changes take effect. Enabling uploading big files ============================ Note: The order of the following steps is important! If you swap steps described below, the settings may fail. -**Go to the admin section in the ownCloud-WebUI and do the following:** +**Go to the admin section in the ownCloud Web Interface and do the following:** * Under "File handling" set the Maximum upload size to the desired value (e.g. 16GB) * Click the "save"-Button -**Open the php.ini - file** +**Configuring your webserver** + +ownCloud comes with a .htaccess - file which propagates all config to your webserver. To adapt those settings go to the ownCloud - Folder on your server and set the following two parameters inside the .htaccess file: + +* ``upload_max_filesize = 16G`` (e.g., to stay consistent with the example value above) +* ``post_max_size = 16G`` (e.g., to stay consistent with the example value above) + +If you don't want to use the shipped .htaccess - file, outcomment those options there and edit them in your global php.ini file: + +You can easily learn the loaded configuration file by saving ```` code piece +into a php file and calling it with your browser. Then look for the **Loaded Configuration File** value. + +Alternatively: * Under Debian or SUSE and their derivatives this file lies at /etc/php5/apache2/php.ini * On Windows, you can find this file within C:/Program Files (x86)/PHP/PHP.ini -**Do the following:** +Set the following two parameters inside the php.ini to the same value as chosen inside the admin-section one step before: -* Set the following three parameters inside th php.ini to the same value as chosen inside the admin-section one step before: -* upload_max_filesize = 16G (e.g., to stay consistent with the example value above) -* post_max_size = 16G (e.g., to stay consistent with the example value above) -* output_buffering = 16384 (e.g., to stay consistent with the example value above) +* ``upload_max_filesize = 16G`` (e.g., to stay consistent with the example value above) +* ``post_max_size = 16G`` (e.g., to stay consistent with the example value above) -whereas the "output_buffering" has to be given in MegaBytes but as a plain figure (without size-units as 'M' or 'G') +**Output Buffering** allows you to get performance benefits in some setups. Please make sure you know what you are doing before using it in production. As previously mentioned, add this option in your .htaccess file or edit your php.ini file: -These client configurations have been proven by testing maximum file sizes of 16 GB: +* ``output_buffering = 16384`` (e.g., to stay consistent with the example value above) + +As you can see, the "output_buffering" has to be given in MegaBytes but as a plain figure (without size-units as 'M' or 'G') + +**These client configurations have been proven by testing maximum file sizes of 16 GB:** * Linux 32 Bit: Ubuntu, Firefox => 16GB * Windows 8 64 Bit: Google Chrome => 8GB diff --git a/admin_manual/configuration/custom_user_backend.rst b/admin_manual/configuration/custom_user_backend.rst index fed51c37b..3d81ffcf7 100644 --- a/admin_manual/configuration/custom_user_backend.rst +++ b/admin_manual/configuration/custom_user_backend.rst @@ -25,7 +25,7 @@ IMAP Provides authentication against IMAP servers - **Class:** OC_User_IMAP -- **Arguments:** a mailbox string as defined `in the PHP documention `_ +- **Arguments:** a mailbox string as defined `in the PHP documentation `_ - **Example:** .. code-block:: php diff --git a/admin_manual/configuration/index.rst b/admin_manual/configuration/index.rst index c3bccd3ef..5e2c6b89a 100644 --- a/admin_manual/configuration/index.rst +++ b/admin_manual/configuration/index.rst @@ -19,7 +19,6 @@ Configuration configuration_language configuration_logging configuration_mail - configuration_maintenance configuration_preview configuration_reverseproxy configuring_big_file_upload diff --git a/admin_manual/configuration/xsendfile.rst b/admin_manual/configuration/xsendfile.rst index 23b487a6b..a9e395641 100644 --- a/admin_manual/configuration/xsendfile.rst +++ b/admin_manual/configuration/xsendfile.rst @@ -119,9 +119,9 @@ 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. -* **/data** ~ The ownCloud datadirectory. Any 'Local' External Storage Mounts must also have nested locations here. +* **/data** ~ The ownCloud data directory. Any 'Local' External Storage Mounts must also have nested locations here. - * set alias if you are using a non-default datadirectory + * set alias if you are using a non-default data directory * **/data/USER/files/LOCAL-MOUNT-NAME** ~ a local external storage mount available to a single user diff --git a/admin_manual/index.rst b/admin_manual/index.rst index 2a042020f..1afe07d98 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -66,7 +66,6 @@ This chapter covers ownCloud and web server configuration. * :doc:`configuration/configuration_3rdparty` * :doc:`configuration/custom_user_backend` * :doc:`configuration/configuration_custom_clients` -* :doc:`configuration/configuration_maintenance` * :doc:`configuration/configuration_knowledgebase` * :doc:`configuration/configuration_logging` * :doc:`configuration/configuration_language` @@ -75,6 +74,8 @@ Maintenance =========== This chapter covers maintenance tasks such as updating or migrating to a new version. + +* :doc:`maintenance/enable_maintenance` * :doc:`maintenance/migrating` * :doc:`maintenance/update` diff --git a/admin_manual/installation/installation_source.rst b/admin_manual/installation/installation_source.rst index 14cd95078..2d9ca62b8 100644 --- a/admin_manual/installation/installation_source.rst +++ b/admin_manual/installation/installation_source.rst @@ -7,7 +7,7 @@ scratch using a classic :abbr:`LAMP (Linux, Apache, MySQL, PHP)` setup: This document provides a complete walk-through for installing ownCloud on Ubuntu 12.04 LTS Server with Apache and MySQL. It also provides guidelines for installing it on other distributions, -webservers and database systems. +web servers and database systems. Prerequisites ~~~~~~~~~~~~~ @@ -132,22 +132,22 @@ First, download the archive of the latest ownCloud version: version number as in the file you have downloaded. * Copy the ownCloud files to their final destination in the document root of your - webserver (you can skip this step if you already downloaded and extracted the + web server (you can skip this step if you already downloaded and extracted the files there):: sudo cp -r owncloud /path/to/your/webservers/document-root where ``/path/to/your/webservers/document-root``, needs to be replaced by the - actual path where the document root of your webserver is configured to be. + actual path where the document root of your web server is configured to be. - * If you don't know where your webserver's document root is located, consult + * If you don't know where your web server's document root is located, consult its documentation. For Apache on Ubuntu 12.04 LTS for example, this would usually be ``/var/www``. So the concrete command to run would be:: sudo cp -r owncloud /var/www * The above assumes you want to install ownCloud into a subdirectory "owncloud" - on your webserver. For installing it anywhere else, you'll have to adapt the + on your web server. For installing it anywhere else, you'll have to adapt the above command accordingly. Set the Directory Permissions @@ -182,7 +182,7 @@ the user running php on your system. sudo chown -R www-data:www-data /var/www/owncloud -* For ArchLinux should run (as root): +* For Arch Linux should run (as root): :: chown -R http:http /path/to/your/owncloud @@ -556,7 +556,7 @@ like this The Apache :file:`.htaccess` that comes with ownCloud is configured to -redirect requests to nonexistent pages. To emulate that behaviour, you +redirect requests to non-existent pages. To emulate that behaviour, you need a custom error handler for yaws. See this `github gist for further instructions`_ on how to create and compile that error handler. @@ -588,7 +588,7 @@ Follow the Install Wizard * Navigate to your ownCloud instance. * If you are installing ownCloud on the same machine as you are accessing the - install wizard from, the url will be https://localhost/owncloud + install wizard from, the URL will be https://localhost/owncloud * If you are installing ownCloud on a different machine, you'll have to access it by its hostname or IP address, e.g. https://example.com/owncloud * If you are using a self-signed certificate, you will be presented with a diff --git a/admin_manual/installation/installation_ucs.rst b/admin_manual/installation/installation_ucs.rst index 06564f7b3..51670b739 100644 --- a/admin_manual/installation/installation_ucs.rst +++ b/admin_manual/installation/installation_ucs.rst @@ -26,8 +26,8 @@ assign your required value. "owncloud/directory/data", "/var/lib/owncloud", "Specifies where the file storage will be placed", "2012.0.1" "owncloud/db/name", "owncloud", "Name of the MySQL database. ownCloud will create an own user for it.", 2012.0.1 "owncloud/user/quota", "(empty)", "The default quota, when a user is being added. Assign values in human readable strings, e.g. “2 GB”. Unlimited if empty.", 2012.0.1 - "owncloud/user/enabled", 0, "Wether a new user is allowed to use ownCloud by default.", 2012.0.1 - "owncloud/group/enabled", "0", "Wether a new group is allowed to be used in ownCloud by default.", 2012.4.0.4 + "owncloud/user/enabled", 0, "Whether a new user is allowed to use ownCloud by default.", 2012.0.1 + "owncloud/group/enabled", "0", "Whether a new group is allowed to be used in ownCloud by default.", 2012.4.0.4 "owncloud/ldap/base/users", "cn=users,$ldap_base", "The users-subtree in the LDAP directory. If left blank it will fall back to the LDAP base.", 2012.4.0.4 "owncloud/ldap/base/groups", "cn=groups,$ldap_base", "The groups-subtree in the LDAP directory. If left blank it will fall back to the LDAP base.", 2012.4.0.4 "owncloud/ldap/groupMemberAssoc", "uniqueMember", "The LDAP attribute showing the group-member relationship. Possible values: uniqueMember, memberUid and member", 2012.4.0.4 diff --git a/admin_manual/installation/installation_windows.rst b/admin_manual/installation/installation_windows.rst index 9a594ff9e..d6271154a 100644 --- a/admin_manual/installation/installation_windows.rst +++ b/admin_manual/installation/installation_windows.rst @@ -24,7 +24,7 @@ Enabling SSL is not yet covered by this section. There are 4 primary steps to the installation, and then a 5th step required for configuring everything to allow files larger than the -default 2MB. +default 2 MB. #. Install IIS with CGI support – enable IIS on your Windows machine. #. Install PHP – Grab, download and install PHP. @@ -255,7 +255,7 @@ There are other changes you can make, such as the timeout duration for uploads, but for now you should be all set in the **PHP.ini** file. Now you have to go back to IIS manager and make one last change to enable file -uploads on the web server larger than 30MB. +uploads on the web server larger than 30 MB. 1. Go to the start menu, and type **iis manager**. 2. Open IIS Manager Select the website you want enable to accept large file diff --git a/admin_manual/configuration/configuration_maintenance.rst b/admin_manual/maintenance/enable_maintenance.rst similarity index 100% rename from admin_manual/configuration/configuration_maintenance.rst rename to admin_manual/maintenance/enable_maintenance.rst diff --git a/admin_manual/maintenance/index.rst b/admin_manual/maintenance/index.rst index e5aed899c..4dee7b5da 100644 --- a/admin_manual/maintenance/index.rst +++ b/admin_manual/maintenance/index.rst @@ -5,6 +5,7 @@ Maintenance .. toctree:: :maxdepth: 1 + enable_maintenance backup update restore diff --git a/admin_manual/maintenance/migrating.rst b/admin_manual/maintenance/migrating.rst index 4dea91c87..e83164c32 100644 --- a/admin_manual/maintenance/migrating.rst +++ b/admin_manual/maintenance/migrating.rst @@ -4,7 +4,7 @@ Migrating ownCloud Installations To migrate an ownCloud install, follow those steps: -#. Backup data/config folders and your database (look at "Backing Up ownCloud") +#. Backup data/config folders and your database (see :doc:`backup`) #. Move your data -#. Restore your data/config folders and your database (look at "Restore ownCloud") +#. Restore your data/config folders and your database (see :doc:`restore`) #. Update config.php of any changes to your database connection