rework login process, drop http auth

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

diff --git a/config.php-dist b/config.php-dist
index 5935dd1261d1b7dc36de01f4ab646bd9568deb4d..bbf45869a175c6f36a8fc946f25178bbc0656e71 100644 (file)
--- a/config.php-dist
+++ b/config.php-dist
@@ -1,4 +1,4 @@
-<?
+<?php
        // Your RDBMS must be configured to accept connections
        // via TCP/IP and authentified by password.
 
@@ -7,20 +7,26 @@
        define('DB_USER', "fox");
        define('DB_NAME', "fox");
        define('DB_PASS', "XXXXXX");
+       //define('DB_PORT', '5432'); // when neeeded, PG-only
+
+       define('MAGPIE_FETCH_TIME_OUT', 60);
+       // Magpie's default timeout is 5 seconds.  Some RSS feeds,
+       // such as from large Trac installs, can take significantly
+       // longer than 5 seconds to generate.  To prevent failed
+       // updates, increase this.
 
        define('MAGPIE_CACHE_DIR', '/var/tmp/magpie-ttrss-cache');
        // Local cache directory for RSS feeds
-       
+
        define('WEB_DEMO_MODE', false);
        // Demo mode with reduced functionality.
+       // Warning: this option is obsolete. Don't rely on it being
+       // checked in all necessary places.
 
        define('ICONS_DIR', "icons");
        define('ICONS_URL', "icons");
        // Local and URL path to the directory, where feed favicons are stored.
 
-       define('USE_HTTP_AUTH', false);
-       // Use HTTP Basic authentication instead of login form. Has some problems.
-
        define('SINGLE_USER_MODE', true);
        // Operate in single user mode, disables all functionality related to
        // multiple users.
@@ -44,6 +50,10 @@
        // directory or it won't be able to find includes. E.g.
        //
        // */30 * * * * cd $TTRSS_DIRECTORY && ./update_feeds.php >/dev/null 2>&1
+
+       // Another alternative approach is to run update_daemon.php in the background
+       // on the server, which allows user-scheduled updates and continous
+       // feed updating in the background. This is the recommended way at the moment.
        
        define('SMART_RPC_COUNTERS', false);
        // If enabled, stores feed counter information on the server side and sends
@@ -56,14 +66,84 @@
        define('GLOBAL_ENABLE_LABELS', false);
        // Labels are a security risk, so this option can globally disable them for all users.
 
-       define('ENABLE_LOGIN_SSL', false);
-       // Redirect to SSL url for login
-
        define('MAIL_RESET_PASS', true);
        // Send mail to user on password reset
        
-       define('MAIL_FROM', 'TT-RSS Daemon <noreply@ttrss.your-shiny-host.org>');
-       // Pretty obvious, I suppose.
-       
+       define('MAIL_FROM', 'TT-RSS Daemon <noreply@some.ttrss.host.dom>');
+       // Pretty obvious, I suppose. Used for email digests & password notifications.
+
+       define('ENABLE_FEED_BROWSER', true);
+       // Enable or disable local feed browser
+
+       define('TMP_DIRECTORY', '/tmp');
+       // Directory for temporary files
+
+       define('FEEDS_FRAME_REFRESH', 600);
+       // Auto refresh interval for feeds frame (in seconds)
+
+       define('MAX_UPDATE_TIME', 0);
+       // Limit one update sequence run to this number of seconds.
+       // The valiue is not exact, because it is being checked between feed updates,
+       // which could use abritrary amount of time.    Feeds which could not be updated
+       // in time, are being skipped.
+       // If this option is enabled (non-zero) feeds are updated in random order.
+       // It is also recommended to set FEEDS_FRAME_REFRESH to a lower value if using
+       // this option.
+
+       define('ENABLE_UPDATE_DAEMON', false);
+       // This enables different mechanism for user-triggered updates designed
+       // for update daemon running in background on the server.
+       // This option suggests FEEDS_FRAME_REFRESH set to a small value 
+       // (like 60 seconds, depending on number of users and server/bandwidth load).
+
+       define('DAEMON_SLEEP_INTERVAL', 120);
+       // Interval between update daemon update runs
+
+       define('DATABASE_BACKED_SESSIONS', false);
+       // Store session information in a database, recommended for multiuser 
+       // configurations. Doesn't seem to work for everyone, so enable with caution.
+       // tt-rss uses default PHP session storing mechanism if disabled.
+
+       define('SESSION_CHECK_ADDRESS', true);
+       // Bind session to client IP address (recommended)
+
+       define('SESSION_COOKIE_LIFETIME', 0);
+       // Default lifetime of a session cookie. In seconds, 
+       // 0 means delete on browser close
+
+       define('SESSION_COOKIE_LIFETIME_REMEMBER', 86400);
+       // Session cookie lifetime if "remember me" is checked on login.
+
+       define('SESSION_EXPIRE_TIME', 86400);
+       // Hard expiration limit for sessions. Should be
+       // >= SESSION_COOKIE_LIFETIME_REMEMBER
+
+       define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
+       // Stop updating feeds of user who was never logged in
+       // in specified amount of days. 0 disables.
+
+       define('CHECK_FOR_NEW_VERSION', true);
+       // Check for new versions of tt-rss when entering preferences.
+
+       define('USE_CURL_FOR_ICONS', false);
+       // Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
+
+       define('DIGEST_ENABLE', true);
+       // Global option to enable daily digests
+
+       define('DIGEST_HOSTNAME', 'some.ttrss.host.dom');
+       // Hostname for email digest signature
+
+       define('DIGEST_EMAIL_LIMIT', 10);
+       // The maximum amount of emails sent in one digest batch
+
+       define('DAEMON_SENDS_DIGESTS', true);
+       // If update daemon and update_feeds should send digests
+       // Disable if you prefer querying special URL (see wiki)
+
+       define('CONFIG_VERSION', 6);
+       // Expected config version. Please update this option in config.php
+       // if necessary (after migrating all new options from this file).
+
        // vim:ft=php
 ?>