diff --git a/config/config.sample.php b/config/config.sample.php index 0a21978ba2..597f01c802 100755 --- a/config/config.sample.php +++ b/config/config.sample.php @@ -5,8 +5,9 @@ * 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 - * consider important for your instance to your configuration. + * YOUR INSTANCE. Instead, manually copy configuration switches that you + * consider important for your instance to your working ``config.php``, and + * apply configuration options that are pertinent for your instance. * * This file is used to generate the config documentation. Please consider * following requirements of the current parser: @@ -38,29 +39,39 @@ $CONFIG = array( /** * This is a unique identifier for your ownCloud installation, created - * automatically by the installer. Do not change it. + * automatically by the installer. This example is for documentation only, + * and you should never use it because it will not work. A valid ``instanceid`` + * is created when you install ownCloud. + * + * 'instanceid' => 'd3c944a9a', */ -'instanceid' => '', -/** + /** * The salt used to hash all passwords, auto-generated by the ownCloud * installer. (There are also per-user salts.) If you lose this salt you lose - * all your passwords. + * all your passwords. This example is for documentation only, + * and you should never use it. + * + *'passwordsalt' => 'd3c944a9af095aa08f', */ -'passwordsalt' => '', /** * Your list of trusted domains that users can log into. Specifying trusted * domains prevents host header poisoning. Do not remove this, as it performs * necessary security checks. */ -'trusted_domains' => array('demo.example.org', 'otherdomain.example.org:8080'), +'trusted_domains' => + array ( + 'demo.example.org', + 'otherdomain.example.org:8080', + ), + /** * Where user files are stored; this defaults to ``data/`` in the ownCloud * directory. The SQLite database is also stored here, when you use SQLite. */ -'datadirectory' => '', +'datadirectory' => '/var/www/owncloud/data', /** * The current version number of your ownCloud installation. This is set up @@ -537,7 +548,12 @@ $CONFIG = array( */ /** - * TODO + * By default, ownCloud can generate previews for the following filetypes: + * Images files + * Covers of MP3 files + * Text documents + * Valid values are ``true``, to enable previews, or + * ``false``, to disable previews */ 'enable_previews' => true, /** @@ -649,7 +665,8 @@ $CONFIG = array( */ /** - * Blacklist a specific file and disallow the upload of files with this name + * Blacklist a specific file or files and disallow the upload of files + * with this name. ``.htaccess`` is blocked by default. * WARNING: USE THIS ONLY IF YOU KNOW WHAT YOU ARE DOING. */ 'blacklisted_files' => array('.htaccess'),