clarify single user mode description

[tt-rss.git] / config.php-dist

diff --git a/config.php-dist b/config.php-dist
index e6c917c31f72eb09136b3dfbb8e9706a50cc4099..eb3339742d5608f77961e141188ff9972c6ff977 100644 (file)
--- a/config.php-dist
+++ b/config.php-dist
@@ -26,7 +26,17 @@
 
        define('SINGLE_USER_MODE', false);
        // Operate in single user mode, disables all functionality related to
-       // multiple users.
+       // multiple users and authentication. Enabling this assumes you have
+       // your tt-rss directory protected by other means (e.g. http auth).
+
+       define('SIMPLE_UPDATE_MODE', false);
+       // Enables fallback update mode where tt-rss tries to update feeds in
+       // background while tt-rss is open in your browser. 
+       // If you don't have a lot of feeds and don't want to or can't run 
+       // background processes while not running tt-rss, this method is generally 
+       // viable to keep your feeds up to date.
+       // Still, there are more robust (and recommended) updating methods 
+       // available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
 
        // *****************************
        // *** Files and directories ***
@@ -52,13 +62,7 @@
        // *** Authentication ***
        // **********************
 
-       define('AUTH_MODULES', 'internal');
-       // Comma-separated list of authentication modules to use. 
-       // Available modules are:
-       // 1. internal - tt-rss internal user DB
-       // 2. remote - use server REMOTE_USER variable or client SSL certificate if enabled
-       // in preferences
-       //
+       // Please see PLUGINS below to configure various authentication modules.
 
        define('AUTH_AUTO_CREATE', true);
        // Allow authentication modules to auto-create users in tt-rss internal
@@ -106,7 +110,7 @@
        // ***********************************
 
        define('ENABLE_REGISTRATION', false);
-       // Allow users to register themselves. Please be vary that allowing
+       // Allow users to register themselves. Please be aware that allowing
        // random people to access your tt-rss installation is a security risk
        // and potentially might lead to data loss or server exploit. Disabled
        // by default.
@@ -122,13 +126,13 @@
        // *** Cookies and login sessions ***
        // **********************************
        
-       define('SESSION_COOKIE_LIFETIME', 0);
+       define('SESSION_COOKIE_LIFETIME', 86400);
        // Default lifetime of a session (e.g. login) cookie. In seconds, 
        // 0 means cookie will be deleted when browser closes.
-
-       define('SESSION_EXPIRE_TIME', 86400);
-       // Hard expiration limit for sessions. Should be
-       // greater or equal to SESSION_COOKIE_LIFETIME
+       // Setting this to zero will affect several user preferences
+       // like widescreen mode not saving and disable "remember me".
+       // Note that if remember me is not checked, session cookie
+       // will always expire with browser session.
 
        define('SESSION_CHECK_ADDRESS', 1);
        // Check client IP address when validating session:
@@ -151,6 +155,9 @@
 
        define('SMTP_HOST', '');
        // SMTP Host to send outgoing mail. Blank - use system MTA.
+       
+       define('SMTP_PORT','');
+       // SMTP port to sent outgoing mail. Default is 25.
 
        define('SMTP_LOGIN', '');
        define('SMTP_PASSWORD', '');
@@ -171,15 +178,12 @@
        // if you experience weird errors and tt-rss failing to start, blank pages
        // after login, or content encoding errors, disable it.
 
-       define('PLUGINS', 'note');
-       // Comma-separated list of plugins to load automatically for all users. 
-       // System plugins have to be specified here.
+       define('PLUGINS', 'auth_internal, note, updater');
+       // Comma-separated list of plugins to load automatically for all users.
+       // System plugins have to be specified here. Please enable at least one
+       // authentication plugin here (auth_*).
        // Users may enable other user plugins from Preferences/Plugins but may not
        // disable plugins specified in this list.
-       
-       define('FEEDBACK_URL', '');
-       // Displays an URL for users to provide feedback or comments regarding
-       // this instance of tt-rss. Can lead to a forum, contact email, etc.
 
        define('CONFIG_VERSION', 26);
        // Expected config version. Please update this option in config.php