diff options
author | Morris Jobke <hey@morrisjobke.de> | 2015-07-07 10:53:06 +0200 |
---|---|---|
committer | Morris Jobke <hey@morrisjobke.de> | 2015-07-09 10:09:11 +0200 |
commit | 509725fad9862099b849c0fb48a67ce4480c9a78 (patch) | |
tree | c8fc162b01483581851546787ef8e8388c1ba468 | |
parent | 447c60c4e46a00d74dd33ce33a7a9b80a06def21 (diff) | |
download | nextcloud-server-509725fad9862099b849c0fb48a67ce4480c9a78.tar.gz nextcloud-server-509725fad9862099b849c0fb48a67ce4480c9a78.zip |
[config sample] improve RST markup and wording
-rw-r--r-- | config/config.sample.php | 42 |
1 files changed, 26 insertions, 16 deletions
diff --git a/config/config.sample.php b/config/config.sample.php index f27ac28a8fd..385d7b8c8dc 100644 --- a/config/config.sample.php +++ b/config/config.sample.php @@ -81,7 +81,7 @@ $CONFIG = array( /** * Where user files are stored; this defaults to ``data/`` in the ownCloud * directory. The SQLite database is also stored here, when you use SQLite. - * (SQLite is available only in ownCloud Community Edition) + * (SQLite is not available in ownCloud Enterprise Edition) */ 'datadirectory' => '/var/www/owncloud/data', @@ -96,7 +96,7 @@ $CONFIG = array( * ``supportedDatabases`` * * Available: - * - sqlite (SQLite3 - Community Edition Only) + * - sqlite (SQLite3 - Not in Enterprise Edition) * - mysql (MySQL/MariaDB) * - pgsql (PostgreSQL) * - oci (Oracle - Enterprise Edition Only) @@ -794,24 +794,34 @@ $CONFIG = array( * Memory caching backend configuration * * Available cache backends: - * * \OC\Memcache\APC Alternative PHP Cache backend - * * \OC\Memcache\APCu APC user backend - * * \OC\Memcache\ArrayCache In-memory array-based backend (not recommended) - * * \OC\Memcache\Memcached Memcached backend - * * \OC\Memcache\Redis Redis backend - * * \OC\Memcache\XCache XCache backend + * + * * ``\OC\Memcache\APC`` Alternative PHP Cache backend + * * ``\OC\Memcache\APCu`` APC user backend + * * ``\OC\Memcache\ArrayCache`` In-memory array-based backend (not recommended) + * * ``\OC\Memcache\Memcached`` Memcached backend + * * ``\OC\Memcache\Redis`` Redis backend + * * ``\OC\Memcache\XCache`` XCache backend + * + * Advice on choosing between the various backends: + * + * * APCu should be easiest to install. Almost all distributions have packages. + * Use this for single user environment for all caches. + * * Use Redis or Memcached for distributed environments. + * For the local cache (you can configure two) take APCu. */ /** * Memory caching backend for locally stored data - * Used for host-specific data, e.g. file paths + * + * * Used for host-specific data, e.g. file paths */ 'memcache.local' => '\OC\Memcache\APCu', /** * Memory caching backend for distributed data - * Used for installation-specific data, e.g. database caching - * If unset, defaults to the value of memcache.local + * + * * Used for installation-specific data, e.g. database caching + * * If unset, defaults to the value of memcache.local */ 'memcache.distributed' => '\OC\Memcache\Memcached', @@ -894,7 +904,7 @@ $CONFIG = array( * Database types that are supported for installation. * * Available: - * - sqlite (SQLite3 - Community Edition Only) + * - sqlite (SQLite3 - Not in Enterprise Edition) * - mysql (MySQL) * - pgsql (PostgreSQL) * - oci (Oracle - Enterprise Edition Only) @@ -970,7 +980,7 @@ $CONFIG = array( /** * All css and js files will be served by the web server statically in one js - * file and one css file if this is set to ``true``. + * file and one css file if this is set to ``true``. This improves performance. */ 'asset-pipeline.enabled' => false, @@ -1016,9 +1026,8 @@ $CONFIG = array( * max file size for animating gifs on public-sharing-site. * If the gif is bigger, it'll show a static preview * - * Value represents the maximum filesize in megabytes - * Default is 10 - * Set to -1 for no limit + * Value represents the maximum filesize in megabytes. Default is ``10``. Set to + * ``-1`` for no limit. */ 'max_filesize_animated_gifs_public_sharing' => 10, @@ -1039,6 +1048,7 @@ $CONFIG = array( /** * Memory caching backend for file locking + * * Because most memcache backends can clean values without warning using redis * is highly recommended to *avoid data loss*. */ |