re-arrange the config options and sort them in a semantical way

This commit is contained in:
Morris Jobke 2014-10-07 10:04:54 +02:00
parent 8ed883bc33
commit 7f328e8b16
1 changed files with 307 additions and 201 deletions

View File

@ -16,16 +16,51 @@
define('DEBUG', true); define('DEBUG', true);
$CONFIG = array( $CONFIG = array(
/** /**
* Flag to indicate ownCloud is successfully installed (true = installed) * Default Parameters
*
* These parameters are configured by the ownCloud installer, and are required
* for your ownCloud server to operate.
*/ */
'installed' => false,
/**
* This is a unique identifier for your ownCloud installation, created
* automatically by the installer.
*/
'instanceid' => '',
/**
* Define the salt used to hash the user passwords. All your user passwords are
* lost if you lose this string.
*/
'passwordsalt' => '',
/**
* List of trusted domains, to prevent host header poisoning ownCloud is only
* using these Host headers
*/
'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
/**
* 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' => '',
/** /**
* Type of database, can be sqlite, mysql or pgsql * Type of database, can be sqlite, mysql or pgsql
*/ */
'dbtype' => 'sqlite', 'dbtype' => 'sqlite',
/**
* Host running the ownCloud database. To specify a port use 'HOSTNAME:####'; to
* specify a unix sockets use 'localhost:/path/to/socket'.
*/
'dbhost' => '',
/** /**
* Name of the ownCloud database * Name of the ownCloud database
*/ */
@ -41,103 +76,23 @@ $CONFIG = array(
*/ */
'dbpassword' => '', 'dbpassword' => '',
/**
* Host running the ownCloud database. To specify a port use 'HOSTNAME:####'; to
* specify a unix sockets use 'localhost:/path/to/socket'.
*/
'dbhost' => '',
/** /**
* Prefix for the ownCloud tables in the database * Prefix for the ownCloud tables in the database
*/ */
'dbtableprefix' => '', 'dbtableprefix' => '',
/** /**
* Define the salt used to hash the user passwords. All your user passwords are * Flag to indicate ownCloud is successfully installed (true = installed)
* lost if you lose this string.
*/ */
'passwordsalt' => '', 'installed' => false,
/** /**
* Secret used by ownCloud for various purposes, e.g. to encrypt data. If you * User Experience
* lose this string there will be data corruption. *
* These optional parameters control some aspects of the user interface. Default
* values, where present, are shown.
*/ */
'secret' => '',
/**
* Force use of HTTPS connection (true = use HTTPS)
*/
'forcessl' => false,
/**
* Blacklist a specific file and disallow the upload of files with this name
* WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
*/
'blacklisted_files' => array('.htaccess'),
/**
* The automatic hostname detection of ownCloud can fail in certain reverse
* proxy and CLI/cron situations. This option allows to manually override the
* automatic detection. You can also add a port. For example
* 'www.example.com:88'
*/
'overwritehost' => '',
/**
* The automatic protocol detection of ownCloud can fail in certain reverse
* proxy and CLI/cron situations. This option allows to manually override the
* protocol detection. For example 'https'
*/
'overwriteprotocol' => '',
/**
* The automatic webroot detection of ownCloud can fail in certain reverse proxy
* and CLI/cron situations. This option allows to manually override the
* automatic detection. For example '/domain.tld/ownCloud'. The value '/' can be
* used to remove the root.
*/
'overwritewebroot' => '',
/**
* The automatic detection of ownCloud can fail in certain reverse proxy and
* CLI/cron situations. This option allows to define a manually override
* condition as regular expression for the remote ip address. For example
* '^10\.0\.0\.[1-3]$'
*/
'overwritecondaddr' => '',
/**
* A proxy to use to connect to the internet. For example 'myproxy.org:88'
*/
'proxy' => '',
/**
* The optional authentication for the proxy to use to connect to the internet.
* The format is: [username]:[password]
*/
'proxyuserpwd' => '',
/**
* List of trusted domains, to prevent host header poisoning ownCloud is only
* using these Host headers
*/
'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
/**
* 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'),
/**
* Theme to use for ownCloud
*/
'theme' => '',
/** /**
* Optional ownCloud default language - overrides automatic language detection * Optional ownCloud default language - overrides automatic language detection
@ -147,16 +102,6 @@ $CONFIG = array(
*/ */
'default_language' => 'en', 'default_language' => 'en',
/**
* Path to the parent directory of the 3rdparty directory
*/
'3rdpartyroot' => '',
/**
* URL to the parent directory of the 3rdparty directory, as seen by the browser
*/
'3rdpartyurl' => '',
/** /**
* Default app to open on login. * Default app to open on login.
* *
@ -172,14 +117,56 @@ $CONFIG = array(
'knowledgebaseenabled' => true, 'knowledgebaseenabled' => true,
/** /**
* Enable installing apps from the appstore * whether avatars should be enabled
*/ */
'appstoreenabled' => true, 'enable_avatars' => true,
/** /**
* URL of the appstore to use, server should understand OCS * allow user to change his display name, if it is supported by the back-end
*/
'allow_user_to_change_display_name' => true,
/**
* Lifetime of the remember login cookie, default is 15 days
*/
'remember_login_cookie_lifetime' => 60*60*24*15,
/**
* Life time of a session after inactivity
*/
'session_lifetime' => 60 * 60 * 24,
/**
* Enable/disable session keep alive when a user is logged in in the Web UI.
* This is achieved by sending a 'heartbeat' to the server to prevent the
* session timing out.
*/
'session_keepalive' => true,
/**
* The directory where the skeleton files are located. These files will be
* copied to the data directory of new users. Leave empty to not copy any
* skeleton files.
*/
'skeletondirectory' => '',
/**
* TODO
*/
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
'arguments' => array('{imap.gmail.com:993/imap/ssl}INBOX')
)
),
/**
* Mail Parameters
*
* These configure the email settings for ownCloud notifications and password
* resets.
*/ */
'appstoreurl' => 'https://api.owncloud.com/v1',
/** /**
* Domain name used by ownCloud for the sender mail address, e.g. * Domain name used by ownCloud for the sender mail address, e.g.
@ -251,16 +238,53 @@ $CONFIG = array(
*/ */
'mail_smtppassword' => '', 'mail_smtppassword' => '',
/** /**
* memcached servers (Only used when xCache, APC and APCu are absent.) * Proxy Configurations
*/
/**
* The automatic hostname detection of ownCloud can fail in certain reverse
* proxy and CLI/cron situations. This option allows to manually override the
* automatic detection. You can also add a port. For example
* 'www.example.com:88'
*/
'overwritehost' => '',
/**
* The automatic protocol detection of ownCloud can fail in certain reverse
* proxy and CLI/cron situations. This option allows to manually override the
* protocol detection. For example 'https'
*/
'overwriteprotocol' => '',
/**
* The automatic webroot detection of ownCloud can fail in certain reverse proxy
* and CLI/cron situations. This option allows to manually override the
* automatic detection. For example '/domain.tld/ownCloud'. The value '/' can be
* used to remove the root.
*/
'overwritewebroot' => '',
/**
* The automatic detection of ownCloud can fail in certain reverse proxy and
* CLI/cron situations. This option allows to define a manually override
* condition as regular expression for the remote ip address. For example
* '^10\.0\.0\.[1-3]$'
*/
'overwritecondaddr' => '',
/**
* A proxy to use to connect to the internet. For example 'myproxy.org:88'
*/
'proxy' => '',
/**
* Deleted Items
*
* These parameters control the Deleted files app.
*/ */
'memcached_servers' => array(
// hostname, port and optional weight. Also see:
// http://www.php.net/manual/en/memcached.addservers.php
// http://www.php.net/manual/en/memcached.addserver.php
array('localhost', 11211),
//array('other.host.local', 11211),
),
/** /**
* How long should ownCloud keep deleted files in the trash bin, default value: * How long should ownCloud keep deleted files in the trash bin, default value:
@ -274,10 +298,13 @@ $CONFIG = array(
*/ */
'trashbin_auto_expire' => true, 'trashbin_auto_expire' => true,
/** /**
* allow user to change his display name, if it is supported by the back-end * ownCloud Verifications
*
* ownCloud performs several verification checks. There are two options, 'true'
* and 'false'.
*/ */
'allow_user_to_change_display_name' => true,
/** /**
* Ensure that 3rdparty applications follows coding guidelines * Ensure that 3rdparty applications follows coding guidelines
@ -306,6 +333,11 @@ $CONFIG = array(
*/ */
'check_for_working_htaccess' => true, 'check_for_working_htaccess' => true,
/**
* Logging
*/
/** /**
* Place to log to, can be 'owncloud' and 'syslog' (owncloud is log menu item in * Place to log to, can be 'owncloud' and 'syslog' (owncloud is log menu item in
* admin menu) * admin menu)
@ -319,17 +351,8 @@ $CONFIG = array(
'logfile' => '', 'logfile' => '',
/** /**
* This entry is just here to show a warning in case somebody copied the sample * Loglevel to start logging at. 0 = DEBUG, 1 = INFO, 2 = WARN, 3 = ERROR
* configuration. DO NOT ADD THIS SWITCH TO YOUR CONFIGURATION! * (default is WARN)
*
* 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,
/**
* Loglevel to start logging at. 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR (default is
* WARN)
*/ */
'loglevel' => 2, 'loglevel' => 2,
@ -363,60 +386,48 @@ $CONFIG = array(
*/ */
'log_rotate_size' => false, 'log_rotate_size' => false,
/**
* Lifetime of the remember login cookie, default is 15 days
*/
'remember_login_cookie_lifetime' => 60*60*24*15,
/** /**
* Life time of a session after inactivity * Alternate Code Locations
*/
'session_lifetime' => 60 * 60 * 24,
/**
* Enable/disable session keep alive when a user is logged in in the Web UI.
* This is achieved by sending a 'heartbeat' to the server to prevent the
* session timing out.
*/
'session_keepalive' => true,
/**
* Custom CSP policy, changing this will overwrite the standard policy
*/
'custom_csp_policy' =>
"default-src 'self'; script-src 'self' 'unsafe-eval'; ".
"style-src 'self' 'unsafe-inline'; frame-src *; img-src *; ".
"font-src 'self' data:; media-src *",
/**
* Enable/disable X-Frame-Restriction
* *
* HIGH SECURITY RISK IF DISABLED * Some of the ownCloud code may be stored in alternate locations.
*/ */
'xframe_restriction' => true,
/** /**
* The directory where the user data is stored, default to data in the owncloud * Path to the parent directory of the 3rdparty directory
* directory. The sqlite database is also stored here, when sqlite is used.
*/ */
'datadirectory' => '', '3rdpartyroot' => '',
/** /**
* The directory where the skeleton files are located. These files will be * URL to the parent directory of the 3rdparty directory, as seen by the browser
* copied to the data directory of new users. Leave empty to not copy any
* skeleton files.
*/ */
'skeletondirectory' => '', '3rdpartyurl' => '',
/** /**
* Enable maintenance mode to disable ownCloud * links to custom clients
*/
'customclient_desktop' =>
'http://owncloud.org/sync-clients/',
'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',
/**
* Apps
* *
* If you want to prevent users to login to ownCloud before you start doing some * Options for the Apps folder, Apps store, and App code checker.
* 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.
*/ */
'maintenance' => false,
/**
* Enable installing apps from the appstore
*/
'appstoreenabled' => true,
/**
* URL of the appstore to use, server should understand OCS
*/
'appstoreurl' => 'https://api.owncloud.com/v1',
/** /**
* Set an array of path for your apps directories * Set an array of path for your apps directories
@ -435,29 +446,22 @@ $CONFIG = array(
), ),
), ),
/**
* @see appcodechecker
*/
/**
* Previews
*
* ownCloud supports previews of image files, the covers of MP3 files, and text
* files. These options control enabling and disabling previews, and thumbnail
* size.
*/
/** /**
* TODO * TODO
*/ */
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
'arguments' => array('{imap.gmail.com:993/imap/ssl}INBOX')
)
),
/**
* links to custom clients
*/
'customclient_desktop' =>
'http://owncloud.org/sync-clients/',
'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',
/**
* PREVIEW
*/
'enable_previews' => true, 'enable_previews' => true,
/** /**
* the max width of a generated preview, if value is null, there is no limit * the max width of a generated preview, if value is null, there is no limit
@ -513,10 +517,38 @@ $CONFIG = array(
'OC\Preview\MarkDown' 'OC\Preview\MarkDown'
), ),
/** /**
* whether avatars should be enabled * Maintenance
*
* These options are for halting user activity when you are performing server
* maintenance.
*/ */
'enable_avatars' => true,
/**
* 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.
*/
'maintenance' => false,
/**
* whether usage of the instance should be restricted to admin users only
*/
'singleuser' => false,
/**
* SSL
*/
/**
* Force use of HTTPS connection (true = use HTTPS)
*/
'forcessl' => false,
/** /**
* Extra SSL options to be used for configuration * Extra SSL options to be used for configuration
@ -525,6 +557,34 @@ $CONFIG = array(
'config' => '/absolute/location/of/openssl.cnf', 'config' => '/absolute/location/of/openssl.cnf',
), ),
/**
* Miscellaneous
*/
/**
* Blacklist a specific file and disallow the upload of files with this name
* WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
*/
'blacklisted_files' => array('.htaccess'),
/**
* define default folder for shared files and folders
*/
'share_folder' => '/',
/**
* Theme to use for ownCloud
*/
'theme' => '',
/**
* Enable/disable X-Frame-Restriction
*
* HIGH SECURITY RISK IF DISABLED
*/
'xframe_restriction' => true,
/** /**
* default cipher used for file encryption, currently we support AES-128-CFB and * default cipher used for file encryption, currently we support AES-128-CFB and
* AES-256-CFB * AES-256-CFB
@ -532,20 +592,15 @@ $CONFIG = array(
'cipher' => 'AES-256-CFB', 'cipher' => 'AES-256-CFB',
/** /**
* whether usage of the instance should be restricted to admin users only * memcached servers (Only used when xCache, APC and APCu are absent.)
*/ */
'singleuser' => false, 'memcached_servers' => array(
// hostname, port and optional weight. Also see:
/** // http://www.php.net/manual/en/memcached.addservers.php
* all css and js files will be served by the web server statically in one js // http://www.php.net/manual/en/memcached.addserver.php
* file and ons css file array('localhost', 11211),
*/ //array('other.host.local', 11211),
'asset-pipeline.enabled' => false, ),
/**
* where mount.json file should be stored
*/
'mount_file' => 'data/mount.json',
/* /*
* Location of the cache folder, defaults to 'data/$user/cache' where '$user' is * Location of the cache folder, defaults to 'data/$user/cache' where '$user' is
@ -578,6 +633,11 @@ $CONFIG = array(
*/ */
'filesystem_check_changes' => 1, 'filesystem_check_changes' => 1,
/**
* where mount.json file should be stored
*/
'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 for all storage
@ -626,8 +686,54 @@ $CONFIG = array(
), ),
/** /**
* define default folder for shared files and folders * Custom CSP policy, changing this will overwrite the standard policy
*/ */
'share_folder' => '/', 'custom_csp_policy' =>
"default-src 'self'; script-src 'self' 'unsafe-eval'; ".
"style-src 'self' 'unsafe-inline'; frame-src *; img-src *; ".
"font-src 'self' data:; media-src *",
/**
* Forgotten ones
*/
/**
* 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
*/
'asset-pipeline.enabled' => false,
); );