From 6632920fa1ba4c0e37c2a50b98f5f1d9104ff2ed Mon Sep 17 00:00:00 2001 From: Sebastian Grewe Date: Tue, 2 Jul 2013 14:08:33 +0200 Subject: [PATCH] Add detailed smarty cache documentation to config Instead of just making it availble document the smarty cache feature. It might work for users, but it's advised to rely on the memcache instead. Fixes #309 --- public/include/config/global.inc.dist.php | 26 +++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/public/include/config/global.inc.dist.php b/public/include/config/global.inc.dist.php index a57c1f22..8bff1114 100644 --- a/public/include/config/global.inc.dist.php +++ b/public/include/config/global.inc.dist.php @@ -341,8 +341,30 @@ $config['cookie']['path'] = '/'; $config['cookie']['name'] = 'POOLERCOOKIE'; $config['cookie']['domain'] = ''; -// Disable or enable smarty cache -// This is usually not required, default: 0 + +/** + * Enable or disable the Smarty cache + * + * Explanation: + * Smarty implements a file based cache for all HTML output generated + * from dynamic scripts. It can be enabled to cache the HTML data on disk, + * future request are served from those cache files. + * + * This may or may not work as expected, in general Memcache is used to cache + * all data so rendering the page should not take too long anyway. + * + * You can test this out and enable (1) this setting but it's not guaranteed to + * work with mmcfe-ng. + * + * Ensure that the folder `templates/cache` is writable by the webserver! + * + * Options: + * 0 = disabled + * 1 = enabled + * + * Default: + * 0 = disabled + **/ $config['cache'] = 0; ?>