[Pkg-owncloud-commits] [owncloud] 215/258: Fixes in config.sample.php
David Prévot
taffit at moszumanska.debian.org
Sat Oct 11 17:22:38 UTC 2014
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch master
in repository owncloud.
commit 47c05e048f5782beefe8f1e80ec661c1e16ba92a
Author: Morris Jobke <hey at morrisjobke.de>
Date: Tue Oct 7 14:14:19 2014 +0200
Fixes in config.sample.php
* owncloud -> ownCloud
* add default value
* proper comment style
* fix line wrapping and minor typo
* remove duplication
* add Vincents proposals
* drop master config switches while backporting
---
config/config.sample.php | 76 ++++++++++++++++++++----------------------------
1 file changed, 31 insertions(+), 45 deletions(-)
diff --git a/config/config.sample.php b/config/config.sample.php
index d9d98a6..b9909ac 100755
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -5,8 +5,17 @@
* configuration options and their usage.
*
* DO NOT COMPLETELY BASE YOUR CONFIGURATION FILE ON THIS SAMPLE. THIS MAY BREAK
- * YOUR INSTANCE. Instead, manually copy configurations' switches that you
+ * YOUR INSTANCE. Instead, manually copy configurations switches that you
* consider important for your instance to your configuration.
+ *
+ * This file is used to generate the config documentation. Please consider
+ * following requirements of the current parser:
+ * * all comments need to start with `/**` and end with ` *\/` - each on their
+ * own line
+ * * add a `@see CONFIG_INDEX` to copy a previously described config option
+ * also to this line
+ * * everything between the ` *\/` and the next `/**` will be treated as the
+ * config option
*/
/**
@@ -45,15 +54,12 @@ $CONFIG = array(
'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
/**
- * The directory where the user data is stored, default to data in the owncloud
+ * The directory where the user data is stored, default to data in the ownCloud
* directory. The sqlite database is also stored here, when sqlite is used.
*/
'datadirectory' => '',
/**
-<<<<<<< HEAD
- * Force use of HTTPS connection (true = use HTTPS)
-=======
* Type of database, can be sqlite, mysql or pgsql
*/
'dbtype' => 'sqlite',
@@ -61,7 +67,6 @@ $CONFIG = array(
/**
* Host running the ownCloud database. To specify a port use 'HOSTNAME:####'; to
* specify a unix sockets use 'localhost:/path/to/socket'.
->>>>>>> 7f328e8... re-arrange the config options and sort them in a semantical way
*/
'dbhost' => '',
@@ -121,12 +126,12 @@ $CONFIG = array(
'knowledgebaseenabled' => true,
/**
- * whether avatars should be enabled
+ * Specifies whether avatars should be enabled
*/
'enable_avatars' => true,
/**
- * allow user to change his display name, if it is supported by the back-end
+ * Allow user to change his display name, if it is supported by the back-end
*/
'allow_user_to_change_display_name' => true,
@@ -221,13 +226,13 @@ $CONFIG = array(
'mail_smtpsecure' => '',
/**
- * authentication needed to send mail, depends on mail_smtpmode if this is used
+ * Authentication needed to send mail, depends on mail_smtpmode if this is used
* (false = disable authentication)
*/
'mail_smtpauth' => false,
/**
- * authentication type needed to send mail, depends on mail_smtpmode if this is
+ * Authentication type needed to send mail, depends on mail_smtpmode if this is
* used Can be LOGIN (default), PLAIN or NTLM
*/
'mail_smtpauthtype' => 'LOGIN',
@@ -316,7 +321,8 @@ $CONFIG = array(
'appcodechecker' => true,
/**
- * Check if ownCloud is up to date
+ * Check if ownCloud is up to date and shows a notification if a new version is
+ * available
*/
'updatechecker' => true,
@@ -349,10 +355,10 @@ $CONFIG = array(
'log_type' => 'owncloud',
/**
- * File for the owncloud logger to log to, (default is ownloud.log in the data
+ * File for the ownCloud logger to log to, (default is owncloud.log in the data
* dir)
*/
-'logfile' => '',
+'logfile' => 'owncloud.log',
/**
* Loglevel to start logging at. 0 = DEBUG, 1 = INFO, 2 = WARN, 3 = ERROR
@@ -360,10 +366,14 @@ $CONFIG = array(
*/
'loglevel' => 2,
-/* date format to be used while writing to the owncloud logfile */
+/**
+ * date format to be used while writing to the ownCloud logfile
+ */
'logdateformat' => 'F d, Y H:i:s',
-/* timezone used while writing to the owncloud logfile (default: UTC) */
+/**
+ * timezone used while writing to the ownCloud logfile (default: UTC)
+ */
'logtimezone' => 'Europe/Berlin',
/**
@@ -379,7 +389,7 @@ $CONFIG = array(
/**
* Configure the size in bytes log rotation should happen, 0 or false disables
- * the rotation. This rotates the current owncloud logfile to a new name, this
+ * the rotation. This rotates the current ownCloud logfile to a new name, this
* way the total log usage will stay limited and older entries are available for
* a while longer. The total disk usage is twice the configured size.
*
@@ -495,6 +505,7 @@ $CONFIG = array(
* Only register providers that have been explicitly enabled
*
* The following providers are enabled by default:
+ *
* - OC\Preview\Image
* - OC\Preview\MarkDown
* - OC\Preview\MP3
@@ -502,6 +513,7 @@ $CONFIG = array(
*
* The following providers are disabled by default due to performance or privacy
* concerns:
+ *
* - OC\Preview\Movies
* - OC\Preview\MSOffice2003
* - OC\Preview\MSOffice2007
@@ -605,7 +617,7 @@ $CONFIG = array(
//array('other.host.local', 11211),
),
-/*
+/**
* Location of the cache folder, defaults to 'data/$user/cache' where '$user' is
* the current user.
*
@@ -622,7 +634,7 @@ $CONFIG = array(
/**
* specifies how often the filesystem is checked for changes made outside
- * owncloud
+ * ownCloud
*
* 0 -> never check the filesystem for outside changes, provides a performance
* increase when it's certain that no changes are made directly to the
@@ -642,7 +654,7 @@ $CONFIG = array(
'mount_file' => 'data/mount.json',
/**
- * If true, prevent owncloud from changing the cache due to changes in the
+ * If true, prevent ownCloud from changing the cache due to changes in the
* filesystem for all storage
*/
'filesystem_cache_readonly' => false,
@@ -702,38 +714,12 @@ $CONFIG = array(
*/
/**
- * Secret used by ownCloud for various purposes, e.g. to encrypt data. If you
- * lose this string there will be data corruption.
- */
-'secret' => '',
-
-/**
* The optional authentication for the proxy to use to connect to the internet.
* The format is: [username]:[password]
*/
'proxyuserpwd' => '',
/**
- * List of trusted proxy servers
- */
-'trusted_proxies' => array('203.0.113.45', '198.51.100.128'),
-
-/**
- * Headers that should be trusted as client IP address in combination with
- * `trusted_proxies`
- */
-'forwarded_for_headers' => array('HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'),
-
-/**
- * This entry is just here to show a warning in case somebody copied the sample
- * configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION!
- *
- * If you, brave person, have read until here be aware that you should not
- * modify *ANY* settings in this file without reading the documentation
- */
-'copied_sample_config' => true,
-
-/**
* all css and js files will be served by the web server statically in one js
* file and ons css file
*/
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git
More information about the Pkg-owncloud-commits
mailing list