From a80fb92eff05e0f2c402e24bb1b8fd32309f9a16 Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Tue, 18 Aug 2015 03:35:13 +0200 Subject: [PATCH] generate documentation from config.sample.php --- .../config_sample_php_parameters.rst | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/admin_manual/configuration_server/config_sample_php_parameters.rst b/admin_manual/configuration_server/config_sample_php_parameters.rst index ec312e300..e6862ed37 100644 --- a/admin_manual/configuration_server/config_sample_php_parameters.rst +++ b/admin_manual/configuration_server/config_sample_php_parameters.rst @@ -20,6 +20,7 @@ ownCloud, and the values in these files take precedence over :file:`config.php`. .. Do not edit this file; edit the source file in core .. DEFAULT_SECTION_START + Default Parameters ------------------ @@ -355,7 +356,7 @@ on your Unix system. 'mail_smtphost' => '127.0.0.1', -This depends on ``mail_smtpmode``. Specified the IP address of your mail +This depends on ``mail_smtpmode``. Specify the IP address of your mail server host. This may contain multiple hosts separated by a semi-colon. If you need to specify the port number append it to the IP address separated by a colon, like this: ``127.0.0.1:24``. @@ -370,7 +371,7 @@ This depends on ``mail_smtpmode``. Specify the port for sending mail. 'mail_smtptimeout' => 10, -This depends on ``mail_smtpmode``. This set an SMTP server timeout, in +This depends on ``mail_smtpmode``. This sets the SMTP server timeout, in seconds. You may need to increase this if you are running an anti-malware or spam scanner. @@ -457,7 +458,7 @@ addresses starting with ``10.0.0.`` and ending with 1 to 3: 'overwrite.cli.url' => '', -Use this configuration parameter to specify the base url for any urls which +Use this configuration parameter to specify the base URL for any URLs which are generated within ownCloud using any kind of command line tools (cron or occ). The value should contain the full base URL: ``https://www.example.com/owncloud`` @@ -500,18 +501,19 @@ initially set to "auto", which is equivalent to the default setting in ownCloud 8.1 and before. Available values: - ``auto`` default setting. keeps files and folders in the trash bin + +* ``auto`` default setting. keeps files and folders in the trash bin for 30 days and automatically deletes anytime after that if space is needed (note: files may not be deleted if space is not needed). - ``D, auto`` keeps files and folders in the trash bin for D+ days, +* ``D, auto`` keeps files and folders in the trash bin for D+ days, delete anytime if space needed (note: files may not be deleted if space is not needed) * ``auto, D`` delete all files in the trash bin that are older than D days automatically, delete other files anytime if space needed * ``D1, D2`` keep files and folders the in trash bin for at least D1 days and delete when exceeds D2 days - ``disabled`` trash bin auto clean disabled, files and folders will be +* ``disabled`` trash bin auto clean disabled, files and folders will be kept forever ownCloud Verifications @@ -656,8 +658,8 @@ Location of the lock file for cron executions can be specified here. Default is within the tmp directory. The file is named in the following way: owncloud-server-$INSTANCEID-cron.lock -where $INSTANCEID is the string specified in the instanceid field. -Because the cron lock file is accessed in regular intervals, it may prevent +where $INSTANCEID is the string specified in the ``instanceid`` field. +Because the cron lock file is accessed at regular intervals, it may prevent enabled disk drives from spinning down. A different location for this file can solve such issues. @@ -776,7 +778,7 @@ size. By default, ownCloud can generate previews for the following filetypes: -- Images files +- Image files - Covers of MP3 files - Text documents @@ -899,7 +901,7 @@ Global settings used by LDAP User and Group Backend 'ldapUserCleanupInterval' => 51, defines the interval in minutes for the background job that checks user -existance and marks them as ready to be cleaned up. The number is always +existence and marks them as ready to be cleaned up. The number is always minutes. Setting it to 0 disables the feature. See command line (occ) methods ldap:show-remnants and user:delete @@ -917,10 +919,10 @@ maintenance. Enable maintenance mode to disable ownCloud -If you want to prevent users to login to ownCloud before you start doing some -maintenance work, you need to set the value of the maintenance parameter to -true. Please keep in mind that users who are already logged-in are kicked out -of ownCloud instantly. +If you want to prevent users from logging in to ownCloud before you start +doing some maintenance work, you need to set the value of the maintenance +parameter to true. Please keep in mind that users who are already logged-in +are kicked out of ownCloud instantly. :: @@ -1156,7 +1158,7 @@ file and one css file if this is set to ``true``. This improves performance. 'assetdirectory' => '/var/www/owncloud', The parent of the directory where css and js assets will be stored if -piplelining is enabled; this defaults to the ownCloud directory. The assets +pipelining is enabled; this defaults to the ownCloud directory. The assets will be stored in a subdirectory of this directory named 'assets'. The server *must* be configured to serve that directory as $WEBROOT/assets. @@ -1221,7 +1223,7 @@ Enables transactional file locking. This is disabled by default as it is still beta. -Prevents concurrent processes to access the same files +Prevents concurrent processes from accessing the same files at the same time. Can help prevent side effects that would be caused by concurrent operations. Mainly relevant for very large installations with many users working with