Skip to content
GitLab
Commit 7f328e8b authored by Morris Jobke's avatar Morris Jobke
Browse files

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

parent 8ed883bc
Hide whitespace changes
Inline Side-by-side
config/config.sample.php
View file @ 7f328e8b
......@@ -16,170 +16,157 @@
define('DEBUG', true);
$CONFIG = array(
/**
* Flag to indicate ownCloud is successfully installed (true = installed)
*/
'installed' => false,
/**
* Type of database, can be sqlite, mysql or pgsql
*/
'dbtype' => 'sqlite',
/**
* Name of the ownCloud database
* Default Parameters
*
* These parameters are configured by the ownCloud installer, and are required
* for your ownCloud server to operate.
*/
'dbname' => 'owncloud',
/**
* User to access the ownCloud database
*/
'dbuser' => '',
/**
* Password to access the ownCloud database
* This is a unique identifier for your ownCloud installation, created
* automatically by the installer.
*/
'dbpassword' => '',
'instanceid' => '',
/**
* Host running the ownCloud database. To specify a port use 'HOSTNAME:####'; to
* specify a unix sockets use 'localhost:/path/to/socket'.
* Define the salt used to hash the user passwords. All your user passwords are
* lost if you lose this string.
*/
'dbhost' => '',
'passwordsalt' => '',
/**
* Prefix for the ownCloud tables in the database
* List of trusted domains, to prevent host header poisoning ownCloud is only
* using these Host headers
*/
'dbtableprefix' => '',
'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
/**
* Define the salt used to hash the user passwords. All your user passwords are
* lost if you lose this string.
* 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.
*/
'passwordsalt' => '',
'datadirectory' => '',
/**
* Secret used by ownCloud for various purposes, e.g. to encrypt data. If you
* lose this string there will be data corruption.
* Type of database, can be sqlite, mysql or pgsql
*/
'secret' => '',
'dbtype' => 'sqlite',
/**
* Force use of HTTPS connection (true = use HTTPS)
* Host running the ownCloud database. To specify a port use 'HOSTNAME:####'; to
* specify a unix sockets use 'localhost:/path/to/socket'.
*/
'forcessl' => false,
'dbhost' => '',
/**
* Blacklist a specific file and disallow the upload of files with this name
* WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
* Name of the ownCloud database
*/
'blacklisted_files' => array('.htaccess'),
'dbname' => 'owncloud',
/**
* 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'
* User to access the ownCloud database
*/
'overwritehost' => '',
'dbuser' => '',
/**
* 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'
* Password to access the ownCloud database
*/
'overwriteprotocol' => '',
'dbpassword' => '',
/**
* 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.
* Prefix for the ownCloud tables in the database
*/
'overwritewebroot' => '',
'dbtableprefix' => '',
/**
* 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]$'
* Flag to indicate ownCloud is successfully installed (true = installed)
*/
'overwritecondaddr' => '',
'installed' => false,
/**
* 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]
* User Experience
*
* These optional parameters control some aspects of the user interface. Default
* values, where present, are shown.
*/
'proxyuserpwd' => '',
/**
* List of trusted domains, to prevent host header poisoning ownCloud is only
* using these Host headers
* Optional ownCloud default language - overrides automatic language detection
* on public pages like login or shared items. This has no effect on the user's
* language preference configured under 'personal -> language' once they have
* logged in
*/
'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'),
'default_language' => 'en',
/**
* List of trusted proxy servers
* Default app to open on login.
*
* This can be a comma-separated list of app ids. If the first app is not
* enabled for the current user, it will try with the second one and so on. If
* no enabled app could be found, the 'files' app will be displayed instead.
*/
'trusted_proxies' => array('203.0.113.45', '198.51.100.128'),
'defaultapp' => 'files',
/**
* Headers that should be trusted as client IP address in combination with
* `trusted_proxies`
* Enable the help menu item in the settings
*/
'forwarded_for_headers' => array('HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'),
'knowledgebaseenabled' => true,
/**
* Theme to use for ownCloud
* whether avatars should be enabled
*/
'theme' => '',
'enable_avatars' => true,
/**
* Optional ownCloud default language - overrides automatic language detection
* on public pages like login or shared items. This has no effect on the user's
* language preference configured under 'personal -> language' once they have
* logged in
* allow user to change his display name, if it is supported by the back-end
*/
'default_language' => 'en',
'allow_user_to_change_display_name' => true,
/**
* Path to the parent directory of the 3rdparty directory
* Lifetime of the remember login cookie, default is 15 days
*/
'3rdpartyroot' => '',
'remember_login_cookie_lifetime' => 60*60*24*15,
/**
* URL to the parent directory of the 3rdparty directory, as seen by the browser
* Life time of a session after inactivity
*/
'3rdpartyurl' => '',
'session_lifetime' => 60 * 60 * 24,
/**
* Default app to open on login.
*
* This can be a comma-separated list of app ids. If the first app is not
* enabled for the current user, it will try with the second one and so on. If
* no enabled app could be found, the 'files' app will be displayed instead.
* 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.
*/
'defaultapp' => 'files',
'session_keepalive' => true,
/**
* Enable the help menu item in the settings
* 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.
*/
'knowledgebaseenabled' => true,
'skeletondirectory' => '',
/**
* Enable installing apps from the appstore
* TODO
*/
'appstoreenabled' => true,
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
'arguments' => array('{imap.gmail.com:993/imap/ssl}INBOX')
)
),
/**
* URL of the appstore to use, server should understand OCS
* 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.
......@@ -251,16 +238,53 @@ $CONFIG = array(
*/
'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:
......@@ -274,10 +298,13 @@ $CONFIG = array(
*/
'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
......@@ -306,6 +333,11 @@ $CONFIG = array(
*/
'check_for_working_htaccess' => true,
/**
* Logging
*/
/**
* Place to log to, can be 'owncloud' and 'syslog' (owncloud is log menu item in
* admin menu)
......@@ -319,17 +351,8 @@ $CONFIG = array(
'logfile' => '',
/**
* 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,
/**
* Loglevel to start logging at. 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR (default is
* WARN)
* Loglevel to start logging at. 0 = DEBUG, 1 = INFO, 2 = WARN, 3 = ERROR
* (default is WARN)
*/
'loglevel' => 2,
......@@ -363,60 +386,48 @@ $CONFIG = array(
*/
'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
*
* Some of the ownCloud code may be stored in alternate 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.
* Path to the parent directory of the 3rdparty directory
*/
'session_keepalive' => true,
'3rdpartyroot' => '',
/**
* Custom CSP policy, changing this will overwrite the standard policy
* URL to the parent directory of the 3rdparty directory, as seen by the browser
*/
'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 *",
'3rdpartyurl' => '',
/**
* Enable/disable X-Frame-Restriction
*
* HIGH SECURITY RISK IF DISABLED
* links to custom clients
*/
'xframe_restriction' => true,
'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',
/**
* 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.
* Apps
*
* Options for the Apps folder, Apps store, and App code checker.
*/
'datadirectory' => '',
/**
* 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.
* Enable installing apps from the appstore
*/
'skeletondirectory' => '',
'appstoreenabled' => 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.
* URL of the appstore to use, server should understand OCS
*/
'maintenance' => false,
'appstoreurl' => 'https://api.owncloud.com/v1',
/**
* Set an array of path for your apps directories
......@@ -436,27 +447,20 @@ $CONFIG = array(
),
/**
* TODO
* @see appcodechecker
*/
'user_backends' => array(
array(
'class' => 'OC_User_IMAP',
'arguments' => array('{imap.gmail.com:993/imap/ssl}INBOX')
)
),
/**
* links to custom clients
* 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.
*/
'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
* TODO
*/
'enable_previews' => true,
/**
......@@ -513,10 +517,38 @@ $CONFIG = array(
'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
......@@ -525,27 +557,50 @@ $CONFIG = array(
'config' => '/absolute/location/of/openssl.cnf',
),
/**
* default cipher used for file encryption, currently we support AES-128-CFB and
* AES-256-CFB
* Miscellaneous
*/
'cipher' => 'AES-256-CFB',
/**
* whether usage of the instance should be restricted to admin users only
* Blacklist a specific file and disallow the upload of files with this name
* WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING.
*/
'singleuser' => false,
'blacklisted_files' => array('.htaccess'),
/**
* all css and js files will be served by the web server statically in one js
* file and ons css file
* define default folder for shared files and folders
*/
'asset-pipeline.enabled' => false,
'share_folder' => '/',
/**
* where mount.json file should be stored
* Theme to use for ownCloud
*/
'mount_file' => 'data/mount.json',
'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
* AES-256-CFB
*/
'cipher' => 'AES-256-CFB',
/**
* memcached servers (Only used when xCache, APC and APCu are absent.)
*/
'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),
),
/*
* Location of the cache folder, defaults to 'data/$user/cache' where '$user' is
......@@ -578,6 +633,11 @@ $CONFIG = array(
*/
'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
* 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,
);
Supports Markdown
0%