[Pkg-owncloud-commits] [owncloud-doc] 233/270: Merge Mark's changes for the user manual
David Prévot
taffit at moszumanska.debian.org
Thu Jul 31 03:53:35 UTC 2014
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch master
in repository owncloud-doc.
commit 3906efcfbf2a55c0df45d9af0c7e614a52584f7b
Author: Daniel Molkentin <daniel at molkentin.de>
Date: Tue Jul 22 16:46:05 2014 +0200
Merge Mark's changes for the user manual
---
admin_manual/configuration/background_jobs.rst | 50 ++++------
.../configuration/configuration_3rdparty.rst | 22 +++--
admin_manual/configuration/configuration_apps.rst | 93 ++++++++++++------
.../configuration/configuration_assets.rst | 9 +-
.../configuration/configuration_automation.rst | 54 ++++++-----
.../configuration/configuration_custom_clients.rst | 12 +--
.../configuration/configuration_database.rst | 45 ++++-----
.../configuration/configuration_language.rst | 2 +-
admin_manual/configuration/configuration_mail.rst | 104 +++++++++++++--------
.../configuration/configuration_preview.rst | 12 +--
.../configuration/configuration_reverseproxy.rst | 2 +-
.../configuration/configuring_big_file_upload.rst | 8 +-
12 files changed, 232 insertions(+), 181 deletions(-)
diff --git a/admin_manual/configuration/background_jobs.rst b/admin_manual/configuration/background_jobs.rst
index 152a705..9c027ea 100644
--- a/admin_manual/configuration/background_jobs.rst
+++ b/admin_manual/configuration/background_jobs.rst
@@ -1,66 +1,50 @@
-Background Jobs
-===============
-A system like ownCloud sometimes requires tasks to be done on a regular
-base without blocking the user interface. For that purpose you, as a system
-administrator, can define background jobs which make it possible to execute
-tasks without any need of user interaction, e.g. database clean-ups etc.
-For the sake of completeness it is worth to know that additionally background
-jobs can also be defined by installed apps.
+Defining Background Jobs
+========================
+A system like ownCloud sometimes requires tasks to be done on a regular basis without the need for user interaction or hindering ownCloud performance. For that purpose, as a system administrator, you can define background jobs (for example, database clean-ups) which make it possible to execute tasks without any need for user interaction.
+
+.. note:: For the sake of completeness, it is worth noting that you can define additional background jobs using installed apps.
Parameters
----------
-In the admin settings menu you can configure how cron-jobs should be executed.
+In the admin settings menu you can configure how cron-jobs should be executed.
You can choose between the following options:
- AJAX
- Webcron
- Cron
-Cron-Jobs
+Cron Jobs
---------
-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.
+ownCloud requires the running of various automated background jobs. These jobs are typically referred to as *cron jobs*. Cron jobs are commands or shell-based scripts that are scheduled to run periodically at fixed times, dates, or intervals. You can schedule cron jobs in three ways -- using AJAX, Webcron, or cron. The default method is to use AJAX. However, the recommended method is to use cron. The following sections describe the differences between each method.
AJAX
~~~~
-This option is the default option, although it is the least reliable. Every
-time a user visits the ownCloud page a single background job will be executed.
-The advantage of this mechanism is, that is does not require access to the
-system nor registration at a third party service.
-The disadvantage of this solution compared to the Webcron service is, that it
-requires regular visits of the page to get triggered.
+The AJAX scheduling method is the default option. Unfortunately, however, it is also the least reliable. Each time a user visits the ownCloud page, a single background job is executed. The advantage of this mechanism is that is does not require access to the system nor registration with a third party service. The disadvantage of this mechanism, when compared to the Webcron service, is that it requires regular visits to the page for it to be triggered.
Webcron
~~~~~~~
By registering your ownCloud ``cron.php`` script address at an external webcron
-service, like e.g. easyCron_, you ensure that background jobs will be executed
-regularly. To use such a service your server need to be reachable via the Internet.
-
-**Example**
-
-::
+service (for example, easyCron_), you ensure that background jobs are executed
+regularly. To use this type of service, your server you must be able to access
+your server using the Internet. For example::
URL to call: http[s]://<domain-of-your-server>/owncloud/cron.php
Cron
~~~~
-Using the systems cron feature is the preferred way to run regular tasks,
-because it allows to execute jobs without the limitations which a web server
-may have.
-
-**Example**
+Using the ownCloud system cron feature is the preferred method for executing regular tasks. This method enables the execution of scheduled jobs without the inherent limitations the web server might have. For example:
-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.
+To run a cron job on a \*nix system, every 15 minutes, under the default web server user (that is, ``www-data``), you must set up the following cron job to call the **cron.php** script::
::
# crontab -u www-data -e
*/15 * * * * php -f /var/www/owncloud/cron.php
-.. _easyCron: http://www.easycron.com/
+.. note:: Please refer to the crontab man page for the exact command syntax.
+
+.. _easyCron: http://www.easycron.com/
diff --git a/admin_manual/configuration/configuration_3rdparty.rst b/admin_manual/configuration/configuration_3rdparty.rst
index a2bceac..1d7e1e4 100644
--- a/admin_manual/configuration/configuration_3rdparty.rst
+++ b/admin_manual/configuration/configuration_3rdparty.rst
@@ -1,16 +1,18 @@
-3rd-Party Configuration
-=======================
+Using Third Party Components
+============================
-ownCloud resorts to some 3rd-party PHP components to provide its functionality.
-These components are part of the software package and are usually shipped in
-the **/3rdparty** folder.
+ownCloud uses some third party PHP components to provide some of its functionality. These components are part of the software package and are contained in the **/3rdparty** folder.
-Parameters
-----------
+Managing Third Party Parameters
+-------------------------------
-If you want to change the default location of the 3rd-party folder you can use the **3rdpartyroot** parameter to define
-the absolute file system path to the folder. The **3rdpartyurl** parameter is used to define the http web path to that
-folder, starting at the ownCloud web root.
+When using third party components, keep the following parameters in mind:
+
+* **3rdpartyroot** -- Specifies the location of the 3rd-party folder. To change the default location of this folder, you can use this parameter to define the absolute file system path to the folder location.
+
+* **3rdpartyurl** -- Specifies the http web path to the 3rdpartyroot folder, starting at the ownCloud web root.
+
+An example of what these parameters might look like is as follows:
.. code-block:: php
diff --git a/admin_manual/configuration/configuration_apps.rst b/admin_manual/configuration/configuration_apps.rst
index dca83df..604293d 100644
--- a/admin_manual/configuration/configuration_apps.rst
+++ b/admin_manual/configuration/configuration_apps.rst
@@ -1,28 +1,62 @@
Apps Configuration
==================
-After you have installed ownCloud, you might realize that it would be nice to
-provide an additional function on top of the core functionality in your ownCloud installation.
+After installing ownCloud, you might want to provide added functionality on top of the core functionality that is installed by default. ownCloud enables you to enhance your experience and your user's experiences by installing various *apps*.
-With ownCloud installation, you will find some apps enabled by default. To see which applications
-are enabled, click on Apps button on the web interface navigation to go into applications page:
+Viewing Enabled Apps
+--------------------
-.. figure:: ../images/oc_admin_app_page.png
+During the ownCloud installation, some apps are enabled by default. To see which apps are enabled:
-Administrator application page
+1. Click ``Apps`` in the Apps Selection Menu.
-In this page, you can enable or disable applications simply by clicking on their names.
-Enabled applications will be shown highlighed while disabled ones will be shown in normal background.
-If the app is not developed by ownCloud, it will have the *3rd party* notice next to it. To see what an
-application does, clicking on its name will show a description on the right side of the same page.
+ The apps available for use with ownCloud appear in the Apps Information Field.
-To install new apps, you can use *More apps* button or check out the `ownCloud apps store <http://apps.owncloud.com/>`_.
-There you will find a lot of ready-to-use apps provided by the ownCloud community.
+ .. figure:: ../images/oc_admin_app_page.png
-If you would like to add your own app, please use *Add your App...* button on the same page. This will redirect you to
-our `Developer Center <http://owncloud.org/dev>`_.
+ **Administrator application page**
-Parameters
-----------
+2. Scroll down the Apps Information Field to view the enabled apps.
+
+ Apps that are enabled appear at he top of the list of apps.
+
+Managing Apps
+-------------
+
+In the Apps page, you can enable or disable applications, as well as modify any app settings, by clicking the app name. If an app is already enabled, it appears highlighted in the list. In addition, enabled apps appear at the top of the app list in the Apps Information Field. In contrast, disabled apps appear below any enabled apps in the list and are not highlighted.
+
+To modify an app:
+
+1. Click the app that you want to modify.
+
+ The app is highlighted and any available settings for the app appear in the Application View window.
+
+2. Make any desired changes to the app.
+
+ All app changes are applied dynamically as soon as you select the change. As there are many apps available for use with ownCloud, we do not list all apps or apps settings that are available to you. However, we have documented several standard apps (for example, the Contacts and Calendar apps) that are directly supported.
+
+Adding Third Party Apps
+-----------------------
+
+As mentioned earlier, ownCloud supports a number of different apps. Some apps are developed and supported by ownCloud directly, while other apps are created by third parties and either included in or available for your ownCloud server installation. Any apps that are not developed by ownCloud show a *3rd party* designation.
+
+To understand what an application does, you can click the app name to view a description of the app and any of the app settings in the Application View field.
+
+Though ownCloud provides many apps in the server installation, you can view many more apps at the `ownCloud apps store <http://apps.owncloud.com/>`_.
+
+To view or install apps from the ownCloud apps store:
+
+1. Scroll to the bottom of the Apps Information Field.
+
+2. Click *More apps*.
+
+ The ownCloud apps store launches.
+
+3. Read about any of the apps in the ownCloud app store and install any that you like.
+
+.. note:: If you would like to create or add your own ownCloud app, please use the *Add your App...* button on the same page. This button redirects you to our `Developer Center <http://owncloud.org/dev>`_ where you can find information about creating and adding your own apps.
+
+Setting App Parameters
+----------------------
Parameters are set in the :file:`config/config.php` inside the **$CONFIG** array.
Use custom app directories
@@ -30,7 +64,7 @@ Use custom app directories
Use the **apps_paths** array to set the apps folders which should be scanned
for available apps and/or where user specific apps should be installed.The key
**path** defines the absolute file system path to the app folder. The key
-**url** defines the http web path to that folder, starting at the ownCloud
+**url** defines the http web path to that folder, starting at the ownCloud
web root. The key **writable** indicates if a user can install apps in that
folder.
@@ -55,13 +89,19 @@ folder.
),
-Use your own appstore
-~~~~~~~~~~~~~~~~~~~~~
-If you want to allow the installation of apps from the apps store you have to
-set **appstoreenabled** parameter, but this can only be done if at least one
-of the configured apps directories is writable.
+Using Your Own Appstore
+~~~~~~~~~~~~~~~~~~~~~~~
+You can enable the installation of apps from your own apps store. However, this requires that you can write to at least one of the configured apps directories.
+
+To enable installation from your own apps store:
+
+1. Set the **appstoreenabled** parameter to "true".
-The **appstoreurl** is used to set the http path to the ownCloud apps store. The appstore server has to use :abbr:`OCS (Open Collaboration Services)`.
+ This parameter is used to enable your apps store in ownCloud.
+
+2. Set the **appstoreurl** to the URL of your ownCloud apps store.
+
+ This parameter is used to set the http path to the ownCloud apps store. The appstore server must use :abbr:`OCS (Open Collaboration Services)`.
.. code-block:: php
@@ -70,9 +110,10 @@ The **appstoreurl** is used to set the http path to the ownCloud apps store. The
"appstoreenabled" => true,
"appstoreurl" => "http://api.apps.owncloud.com/v1",
-Guard against malicious 3rdparty code
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Finally you can enable checks for malicious code fragments of 3rd-party apps
+Guarding Against Malicious Code
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can enable checks for malicious code fragments in third party apps
by setting the **appcodechecker** parameter.
.. code-block:: php
diff --git a/admin_manual/configuration/configuration_assets.rst b/admin_manual/configuration/configuration_assets.rst
index 9e0cb11..add6d0d 100644
--- a/admin_manual/configuration/configuration_assets.rst
+++ b/admin_manual/configuration/configuration_assets.rst
@@ -1,10 +1,11 @@
Asset Management
================
-In productive environments JavaScript and CSS files shall be delivered concatenated and minified.
+In production environments, JavaScript and CSS files are delivered in a concatenated and compressed format.
-ownCloud will create individual JavaScript and CSS files in a folder names 'assets' in the web root. This
-folder has to be owned by the web server user and will be used for static delivery of these files.
+# Original sentence: "In productive environments JavaScript and CSS files shall be delivered concatenated and minified."
+
+ownCloud creates individual JavaScript and CSS files and saves them in a folder called 'assets' in the web root. This folder must be owned by the web server user and is used for static delivery of these files.
Parameters
@@ -17,4 +18,4 @@ Parameters
'asset-pipeline.enabled' => true,
-This parameters can be set in the :file:`config/config.php`
+You can set this parameters in the :file:`config/config.php`
diff --git a/admin_manual/configuration/configuration_automation.rst b/admin_manual/configuration/configuration_automation.rst
index b9f6af5..207c117 100644
--- a/admin_manual/configuration/configuration_automation.rst
+++ b/admin_manual/configuration/configuration_automation.rst
@@ -1,21 +1,19 @@
-Automatic Configuration
-=======================
+Defining Automatic Configuration
+================================
-If you need to install ownCloud on multiple servers you normally do not want
-to set-up each instance separately as described in the :doc:`configuration_database`.
-For this reason the automatic configuration feature has been introduced.
+If you need to install ownCloud on multiple servers, you normally do not want
+to set up each instance separately as described in the :doc:`configuration_database`.
+For this reason, ownCloud provides an automatic configuration feature.
-To take advantage of this feature you need to create a configuration file, called
-:file:`../owncloud/config/autoconfig.php` and set the parameters as required.
-You can provide all parameters or just part of them - parameters which haven't been provided (if any) will be asked
-at "Finish setup" screen at first run of ownCloud.
+To take advantage of this feature, you must create a configuration file, called
+:file:`../owncloud/config/autoconfig.php`, and set the file parameters as required.
+You can specify any number of parameters in this file. Any unspecified parameters appear on the "Finish setup" screen when you first launch ownCloud.
-The :file:`../owncloud/config/autoconfig.php` will be automatically removed after the initial configuration has been applied.
+The :file:`../owncloud/config/autoconfig.php` is automatically removed after the initial configuration has been applied.
Parameters
----------
-You need to keep in mind that two parameters are named differently in this
-configuration file compared to the normal :file:`config.php`.
+When configuring parameters, you must understand that two parameters are named differently in this configuration file when compared to the standard :file:`config.php` file.
+----------------+---------------+
| autoconfig.php | config.php |
@@ -25,12 +23,14 @@ configuration file compared to the normal :file:`config.php`.
| dbpass | dbpassword |
+----------------+---------------+
-Sample Automatic Configurations
--------------------------------
+Automatic Configurations Examples
+---------------------------------
+
+The following sections provide sample automatic configuration examples and what information is requested at the end of the configuration.
Data Directory
~~~~~~~~~~~~~~
-With the configuration below the "Finish setup" screen still will ask for database and admin credentials settings.
+Using the following parameter settings, the "Finish setup" screen requests database and admin credentials settings.
.. code-block:: php
@@ -42,7 +42,7 @@ With the configuration below the "Finish setup" screen still will ask for databa
SQLite Database
~~~~~~~~~~~~~~~
-With the configuration below the "Finish setup" screen still will ask for data directory and admin credentials settings.
+Using the following parameter settings, the "Finish setup" screen requests data directory and admin credentials settings.
.. code-block:: php
@@ -55,10 +55,7 @@ With the configuration below the "Finish setup" screen still will ask for data d
MySQL Database
~~~~~~~~~~~~~~
-Keep in mind that the automatic configuration does not unburden you from creating the database user and database
-in advance, as described in :doc:`configuration_database`.
-
-With the configuration below the "Finish setup" screen still will ask for data directory and admin credentials settings.
+Using the following parameter settings, the "Finish setup" screen requests data directory and admin credentials settings.
.. code-block:: php
@@ -72,12 +69,11 @@ With the configuration below the "Finish setup" screen still will ask for data d
"dbtableprefix" => "",
);
+.. note:: Keep in mind that the automatic configuration does not eliminate the need for creating the database user and database in advance, as described in :doc:`configuration_database`.
+
PostgreSQL Database
~~~~~~~~~~~~~~~~~~~
-Keep in mind that the automatic configuration does not unburden you from creating the database user and database
-in advance, as described in :doc:`configuration_database`.
-
-With the configuration below the "Finish setup" screen still will ask for data directory and admin credentials settings.
+Using the following parameter settings, the "Finish setup" screen requests data directory and admin credentials settings.
.. code-block:: php
@@ -90,13 +86,13 @@ With the configuration below the "Finish setup" screen still will ask for data d
"dbhost" => "localhost",
"dbtableprefix" => "",
);
-
+
+.. note:: Keep in mind that the automatic configuration does not eliminate the need for creating the database user and database in advance, as described in :doc:`configuration_database`.
+
All Parameters
~~~~~~~~~~~~~~
-Keep in mind that the automatic configuration does not unburden you from creating the database user and database
-in advance, as described in :doc:`configuration_database`.
-With the configuration below "Finish setup" will be skipped at first ownCloud run since all parameters are already preconfigured.
+Using the following parameter settings, because all parameters are already configured in the file, the ownCloud installation skips the "Finish setup" screen.
.. code-block:: php
@@ -113,3 +109,5 @@ With the configuration below "Finish setup" will be skipped at first ownCloud ru
"directory" => "/www/htdocs/owncloud/data",
);
+.. note:: Keep in mind that the automatic configuration does not eliminate the need for creating the database user and database in advance, as described in :doc:`configuration_database`.
+
diff --git a/admin_manual/configuration/configuration_custom_clients.rst b/admin_manual/configuration/configuration_custom_clients.rst
index 75f0016..90e9039 100644
--- a/admin_manual/configuration/configuration_custom_clients.rst
+++ b/admin_manual/configuration/configuration_custom_clients.rst
@@ -2,9 +2,11 @@ Custom Client Configuration
===========================
If you want to access your ownCloud, you can choose between the standard Web-GUI
-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:
+and various client synchronization applications.
+
+.. note:: Download links that point to these applications are shown at the top of the Personal Settings Menu.
+
+The following sync applications are currently available by default:
* Desktop sync clients for Windows, MAC and Linux OS
* Mobile sync client for Android devices
@@ -13,8 +15,7 @@ applications are currently available out of the box:
Parameters
----------
-If you want to customize the download links for the sync clients the following
-parameters need to be modified to fulfil your requirements:
+You can customize the download links to meet your specific requirements for any of the synchronization clients in the :file:`config/config.php` file:
.. code-block:: php
@@ -24,4 +25,3 @@ parameters need to be modified to fulfil your requirements:
"customclient_android" => "https://play.google.com/store/apps/details?id=com.owncloud.android",
"customclient_ios" => "https://itunes.apple.com/us/app/owncloud/id543672169?mt=8",
-This parameters can be set in the :file:`config/config.php`
diff --git a/admin_manual/configuration/configuration_database.rst b/admin_manual/configuration/configuration_database.rst
index 763476c..577f3c3 100644
--- a/admin_manual/configuration/configuration_database.rst
+++ b/admin_manual/configuration/configuration_database.rst
@@ -1,43 +1,38 @@
Database Configuration
======================
-ownCloud requires a database where administrative data will be held. Four
-different database types are currently supported,
-`MySQL <http://www.mysql.com/>`_ / `MariaDB <https://mariadb.org/>`_,
-`SQLite <http://www.sqlite.org/>`_, `PostgreSQL <http://www.postgresql.org/>`_
-and `Oracle <http://www.oracle.com/>`_. MySQL or MariaDB are the recommended
-database engines. By default SQLite is chosen because it is a file based
-database with the least administrative overhead.
+ownCloud requires a database in which administrative data is stored. The following databases are currently supported:
-.. note:: Because SQLite handles multiple users very badly SQLite is only
- recommended for single user ownCloud installations.
+* `MySQL <http://www.mysql.com/>`_ / MariaDB <https://mariadb.org/>`
+* `SQLite <http://www.sqlite.org/>`
+* `PostgreSQL <http://www.postgresql.org/>`_
+* `Oracle <http://www.oracle.com/>`_
+
+The MySQL or MariaDB databases are the recommended database engines. However, because it is a file based database with the least administrative overhead, SQLite is chosen by default.
+
+.. note:: Because SQLite has some difficulties handling multiple users, we recommend that it be used only for single user ownCloud installatins.
Requirements
------------
-If you decide to use MySQL / MariaDB, PostgreSQL or Oracle, you need to install
-and set up the server software first. These steps will not be covered by this
-description as they are easy to find elsewhere.
+Choosing to use MySQL / MariaDB, PostgreSQL, or Oracle as your database requires that you install and set up the server software first.
+
+.. note:: The steps for configuring a third party database are beyond the scope of this document. Please refer to the documentation for your specific database choice for instructions.
Parameters
----------
+For setting up ownCloud to use any database, use the instructions in :doc:`../installation/installation_wizard`. You should not have to edit the respective values in the :file:`config/config.php`. However, in special cases (for example, if you want to connect your ownCloud instance to a database created by a previous installation of ownCloud), some modification might be required.
+
+Configuring a MySQL or MariaDB Database
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. note:: For setting up ownCloud to use any of these databases, use the
- :doc:`../installation/installation_wizard`.
- You usually don't need to edit the respective values in the
- :file:`config/config.php`, just in special cases e.g. if you want to
- connect your ownCloud instance to a database created by a previous
- installation of ownCloud.
+If you decide to use a MySQL or MariaDB database, ensure the following:
-MySQL/MariaDB Database
-~~~~~~~~~~~~~~~~~~~~~~
+* That you have installed and enabled the MySQL extension in PHP
-If you decide to use a MySQL or MariaDB database make sure that you have installed and
-enabled the MySQL extension in PHP and that the **mysql.default_socket**
-points to the correct socket (if the database runs on same server as ownCloud).
+* That the **mysql.default_socket** points to the correct socket (if the database runs on same server as ownCloud).
-Please note that MariaDB is backwards compatible with MySQL, so all instructions will work for both.
-You will not need to replace mysql with anything.
+.. note:: MariaDB is backwards compatible with MySQL. All instructions work for both. You will not need to replace mysql with anything.
The PHP configuration in :file:`/etc/php5/conf.d/mysql.ini` could look like this:
diff --git a/admin_manual/configuration/configuration_language.rst b/admin_manual/configuration/configuration_language.rst
index 3a38bcb..9966468 100644
--- a/admin_manual/configuration/configuration_language.rst
+++ b/admin_manual/configuration/configuration_language.rst
@@ -9,7 +9,7 @@ Please keep in mind, that this will not effect a users language preference,
which has been configured under "personal -> language" once he has logged in.
Please check :file:`settings/languageCodes.php` for the list of supported language
-codes.
+codes.
Parameters
diff --git a/admin_manual/configuration/configuration_mail.rst b/admin_manual/configuration/configuration_mail.rst
index 5f52aa3..c44d426 100644
--- a/admin_manual/configuration/configuration_mail.rst
+++ b/admin_manual/configuration/configuration_mail.rst
@@ -185,15 +185,49 @@ 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.
+Using Email Templates
+---------------------
+
+As an added convenience to administrators, ownCloud provides several Email templates that you can use for sending messages to users.
+
+.. figure:: ../images/remote_shares.png
+
+Found on the Admin page, you can choose from the following templates:
+
+* Sharing email (http) -- You can use this template to send emails to users about sharing links.
+
+* Sharing email -- You can use this template to send emails to users about sharing files.
+
+* Lost password mail -- When managing users, you can use this template to send emails to users about lost password recovery.
+
+* Activity notification mail -- You can use this template to send emails to users detailing their ownCloud activity.
+
+In addition to providing the Email templates, this feature enables you to apply any preconfigured themes to the email.
+
+To modify an email template to users:
+
+1. Access the Admin page.
+
+2. Scroll to the Mail templates section.
+
+3. Select a template from the drop-down menu.
+
+4. Make any desired modifications to the template.
+
+ .. note:: You can edit the templates directly in the template text box or you can copy and paste them to a text editor for modification and then copy and paste them back to the template text box for use when you are done.
+
+5. Click ``Save`` to the file modifications.
+
+ Once complete, the files are sent to users who choose to receive notifications through email.
+
+ .. note:: ownCloud populates the variables with usernames and filenames prior to sending the email.
Troubleshooting
----------------
-My web domain is different from my mail domain?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+**Question**: Why is my web domain different from my mail domain?
-The default domain name used for the sender address is the hostname where your ownCloud installation is served.
-If you have a different mail domain name you can override this behavior by setting the following configuration parameter:
+**Answer**: The default domain name used for the sender address is the hostname where your ownCloud installation is served. If you have a different mail domain name you can override this behavior by setting the following configuration parameter:
.. code-block:: php
@@ -201,14 +235,13 @@ If you have a different mail domain name you can override this behavior by setti
"mail_domain" => "example.com",
-Now every mail send by ownCloud e.g. password reset email, will have the domain part of the sender address look like::
-
+This setting results in every email sent by ownCloud (for example, the password reset email) having the domain part of the sender address appear as follows::
+
no-reply at example.com
-How can I find out if a SMTP server is reachable?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+**Question**: How can I find out if a SMTP server is reachable?
-Use the ping command to check the server availability::
+**Answer**: Use the ping command to check the server availability::
ping smtp.server.dom
@@ -219,12 +252,10 @@ Use the ping command to check the server availability::
64 bytes from your-server.local.lan (192.168.1.10): icmp_req=2 ttl=64 time=0.055 ms
64 bytes from your-server.local.lan (192.168.1.10): icmp_req=3 ttl=64 time=0.062 ms
-How can I find out if the SMTP server is listening on a specific tcp port?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+**Question**: How can I find out if the SMTP server is listening on a specific TCP port?
-A SMTP server is usually listening on port **25/tcp** (smtp) and/or in
-rare circumstances is also listening on the outdated port **465/tcp** (smtps).
-You can use the telnet command to check if a port is available::
+**Answer**: SMTP servers usually listen on port **25/tcp** (smtp). In
+rare circumstances the SMTP server also listens on the outdated port **465/tcp** (smtps). You can use the ``telnet`` command to determining if a port is available::
telnet smtp.domain.dom 25
@@ -235,16 +266,17 @@ You can use the telnet command to check if a port is available::
Escape character is '^]'.
220 smtp.domain.dom ESMTP Exim 4.80.1 Tue, 22 Jan 2013 22:28:14 +0100
-How can I find out if a SMTP server supports the outdated SMTPS protocol?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A good indication that a SMTP server supports the SMTPS protocol is that it
-is listening on port **465/tcp**. How this can be checked has been described
-previously.
+**Question**: How can I determine if the SMTP server supports the outdated SMTPS protocol?
+
+**Answer**: A good indication that the SMTP server supports the SMTPS protocol is that it is listening on port **465/tcp**. See the previous answer to use the ``telnet`` command for checking the port availability.
+
+**Question**: How can I determine if the SMTP server supports the TLS protocol?
+
+**Answer**: SMTP servers usually announce the availability of STARTTLS immediately after a connection has been established. You can easily check this using the ``telnet`` command.
+
+.. note:: You must enter the marked lines to obtain the information displayed.
-How can I find out if a SMTP server supports the TLS protocol?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A SMTP server usually announces the availability of STARTTLS right after a
-connection has been established. This can easily been checked with the telnet command. You need to enter the marked lines to get the information displayed::
+::
telnet smtp.domain.dom 25
@@ -266,12 +298,13 @@ connection has been established. This can easily been checked with the telnet co
221 smtp.domain.dom closing connection
Connection closed by foreign host.
-How can I find out which authentication types/methods a SMTP server supports?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A SMTP server usually announces the available authentication types/methods
-right after a connection has been established. This can easily been checked
-with the telnet command. You need to enter the marked lines to get the
-information displayed::
+**Question**: How can I determine which authentication types or methods the SMTP server supports?
+
+**Answer**: SMTP servers usually announce the available authentication types or methods immediately following the establishment of a connection. You can easily check this using the telnet command.
+
+.. note:: You must enter the marked lines to obtrain the information displayed.
+
+::
telnet smtp.domain.dom 25
@@ -293,15 +326,10 @@ information displayed::
221 smtp.domain.dom closing connection
Connection closed by foreign host.
+Enabling Debug Mode
+-------------------
-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 **Send email** button, as described before, a
-lot of **SMTP -> get_lines(): ...** messages will be written on the
-screen.
+If you are unable to send email, it might be useful to activate further debug messages by enabling the mail_smtpdebug parameter::
.. code-block:: php
@@ -309,3 +337,5 @@ screen.
"mail_smtpdebug" => true;
+.. note:: Immediately after pressing the **Send email** button, as described before, several **SMTP -> get_lines(): ...** messages appear on the screen. This is expected behavior and can be ignored.
+
diff --git a/admin_manual/configuration/configuration_preview.rst b/admin_manual/configuration/configuration_preview.rst
index 9512159..b57b178 100644
--- a/admin_manual/configuration/configuration_preview.rst
+++ b/admin_manual/configuration/configuration_preview.rst
@@ -1,16 +1,16 @@
Preview Configuration
=====================
ownCloud 6 introduced the new thumbnail system. It is used to generate
-thumbnails from various file types.
+thumbnails from various file types.
By default, it can generate previews for:
* Images
* Movies
-* Cover from mp3 files
-* various office files
-* Pdf
-* Svg
-* Text
+* Cover from mp3 files
+* various office files
+* Pdf
+* Svg
+* Text
Soft dependencies:
------------------
diff --git a/admin_manual/configuration/configuration_reverseproxy.rst b/admin_manual/configuration/configuration_reverseproxy.rst
index 9b94aa9..6292bcc 100644
--- a/admin_manual/configuration/configuration_reverseproxy.rst
+++ b/admin_manual/configuration/configuration_reverseproxy.rst
@@ -20,7 +20,7 @@ set it. The **overwritecondaddr** parameter is used to overwrite the values
dependent on the remote address. The value must be a **regular expression** of
the IP addresses of the proxy. This is useful when you use a reverse SSL proxy
only for https access and you want to use the automatic detection for http
-access.
+access.
Example
-------
diff --git a/admin_manual/configuration/configuring_big_file_upload.rst b/admin_manual/configuration/configuring_big_file_upload.rst
index 63d43aa..ba8d9c5 100644
--- a/admin_manual/configuration/configuring_big_file_upload.rst
+++ b/admin_manual/configuration/configuring_big_file_upload.rst
@@ -41,7 +41,7 @@ into a php file and calling it with your browser. Then look for the **Loaded Con
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
+* On Windows, you can find this file within C:/Program Files (x86)/PHP/PHP.ini
Set the following two parameters inside the php.ini to the same value as chosen inside the admin-section one step before:
@@ -56,10 +56,10 @@ As you can see, the "output_buffering" has to be given in MegaBytes but as a pla
**These client configurations have been proven by testing maximum file sizes of 16 GB:**
-* Linux 32 Bit: Ubuntu, Firefox => 16GB
+* Linux 32 Bit: Ubuntu, Firefox => 16GB
* Windows 8 64 Bit: Google Chrome => 8GB
**Note:**
-You will need a minimum of 16GB (e.g, to stay consistent with the example value above), in your upload_tmp_dir.
-Normally this points to /tmp. If your /tmp has not enough space,
+You will need a minimum of 16GB (e.g, to stay consistent with the example value above), in your upload_tmp_dir.
+Normally this points to /tmp. If your /tmp has not enough space,
you can change the value of upload_tmp_dir in your php.ini
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git
More information about the Pkg-owncloud-commits
mailing list