X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=config.php-dist;h=93fbb1ab5255672fbbd4c5cb371d24ca7b453e12;hb=dd8c36af4be29c311cd3d6094b083371a4794368;hp=f03f5f8e7eca2ddf0dca373f2116c03a2bf4609a;hpb=4f7956b3df7a7f87bbf7f70d9902edbd0264b43f;p=tt-rss.git

diff --git a/config.php-dist b/config.php-dist
index f03f5f8e..93fbb1ab 100644
--- a/config.php-dist
+++ b/config.php-dist
@@ -1,6 +1,7 @@
 <?php
-	// Your RDBMS must be configured to accept connections
-	// via TCP/IP and authentified by password.
+	// *******************************************
+	// *** Database configuration (important!) ***
+	// *******************************************
 
 	define('DB_TYPE', "pgsql"); // or mysql
 	define('DB_HOST', "localhost");
@@ -9,78 +10,123 @@
 	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('MYSQL_CHARSET', 'UTF8');
+	// Connection charset for MySQL. If you have a legacy database and/or experience
+	// garbage unicode characters with this option, try setting it to a blank string.
 
-	define('MAGPIE_CACHE_DIR', '/var/tmp/magpie-ttrss-cache');
-	// Local cache directory for RSS feeds
+	// ***********************************
+	// *** Basic settings (important!) ***
+	// ***********************************
 
-	define('MAGPIE_CACHE_AGE', 60*30); 
-	// How long to store cached RSS objects? In seconds.
-	// Defaults to 30 minutes
+	define('SELF_URL_PATH', 'http://yourserver/tt-rss/');
+	// Full URL of your tt-rss installation. This should be set to the
+	// location of tt-rss directory, e.g. http://yourserver/tt-rss/
+	// You need to set this option correctly otherwise several features
+	// including PUSH, bookmarklets and browser integration will not work properly.
 
-	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('SINGLE_USER_MODE', true);
+	define('SINGLE_USER_MODE', false);
 	// Operate in single user mode, disables all functionality related to
 	// multiple users.
-	
-	define('SMART_RPC_COUNTERS', false);
-	// If enabled, stores feed counter information on the server side and sends
-	// only diffs to the client. In the nutshell, it saves your bandwidth and
-	// makes UI more responsive, but eats server memory.
-	// This option can introduce a lot of weird interface glitches in
-	// some use-cases (if you have more than one tt-rss window open, for example)
-	// so it is disabled by default.
-
-	define('MAIL_RESET_PASS', true);
-	// Send mail to user on password reset
-	
-	define('ENABLE_FEED_BROWSER', true);
-	// Enable or disable local feed browser
 
-	define('TMP_DIRECTORY', '/tmp');
-	// Directory for temporary files
+	// *****************************
+	// *** Files and directories ***
+	// *****************************
 
-	define('FEEDS_FRAME_REFRESH', 600);
-	// Auto refresh interval for feeds frame (in seconds)
+	define('PHP_EXECUTABLE', '/usr/bin/php');
+	// Path to PHP executable, used for various command-line tt-rss programs
 
-	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('LOCK_DIRECTORY', 'lock');
+	// Directory for lockfiles, must be writable to the user you run
+	// daemon process or cronjobs under.
+
+	define('CACHE_DIR', 'cache');
+	// Local cache directory for RSS feed content.
 
-	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('ICONS_DIR', "feed-icons");
+	define('ICONS_URL', "feed-icons");
+	// Local and URL path to the directory, where feed favicons are stored.
+	// Unless you really know what you're doing, please keep those relative
+	// to tt-rss main directory.
+
+	// **********************
+	// *** 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
+	//
+
+	define('AUTH_AUTO_CREATE', true);
+	// Allow authentication modules to auto-create users in tt-rss internal
+	// database when authenticated successfully.
+
+	define('AUTH_AUTO_LOGIN', true);
+	// Automatically login user on remote or other kind of externally supplied
+	// authentication, otherwise redirect to login form as normal.
+	// If set to true, users won't be able to set application language
+	// and settings profile.
+
+	// *********************
+	// *** Feed settings ***
+	// *********************
+
+	define('DEFAULT_UPDATE_METHOD', 0);
+	// Which feed parsing library to use as default:
+	// 0 - Magpie
+	// 1 - SimplePie
+
+	define('FORCE_ARTICLE_PURGE', 0);
+	// When this option is not 0, users ability to control feed purging
+	// intervals is disabled and all articles (which are not starred) 
+	// older than this amount of days are purged.
+
+	// *** PubSubHubbub settings ***
+
+	define('PUBSUBHUBBUB_HUB', '');
+	// URL to a PubSubHubbub-compatible hub server. If defined, "Published
+	// articles" generated feed would automatically become PUSH-enabled.
+
+	define('PUBSUBHUBBUB_ENABLED', false);
+	// Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
+	// won't try to subscribe to PUSH feed updates.
+
+	// *********************
+	// *** Sphinx search ***
+	// *********************
+
+	define('SPHINX_ENABLED', false);
+	// Enable fulltext search using Sphinx (http://www.sphinxsearch.com)
+	// Please see http://tt-rss.org/wiki/SphinxSearch for more information.
+
+	define('SPHINX_INDEX', 'ttrss');
+	// Index name in Sphinx configuration. You can specify multiple indexes
+	// as a comma-separated string.
+
+	// ***********************************
+	// *** Self-registrations by users ***
+	// ***********************************
 
-	define('DAEMON_SLEEP_INTERVAL', 120);
-	// Interval between update daemon update runs
+	define('ENABLE_REGISTRATION', false);
+	// Allow users to register themselves. Please be vary 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.
 
-	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('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
+	// Email address to send new user notifications to.
 
-	define('SESSION_CHECK_ADDRESS', true);
-	// Bind session to client IP address (recommended)
+	define('REG_MAX_USERS', 10);
+	// Maximum amount of users which will be allowed to register on this
+	// system. 0 - no limit.
 
+	// **********************************
+	// *** Cookies and login sessions ***
+	// **********************************
+	
 	define('SESSION_COOKIE_LIFETIME', 0);
 	// Default lifetime of a session (e.g. login) cookie. In seconds, 
 	// 0 means cookie will be deleted when browser closes.
@@ -89,115 +135,58 @@
 	// Hard expiration limit for sessions. Should be
 	// greater or equal to SESSION_COOKIE_LIFETIME
 
-	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_EMAIL_LIMIT', 10);
-	// The maximum amount of emails sent in one digest batch
+	define('SESSION_CHECK_ADDRESS', 1);
+	// Check client IP address when validating session:
+	// 0 - disable checking
+	// 1 - check first 3 octets of an address (recommended)
+	// 2 - check first 2 octets of an address
+	// 3 - check entire address
 
-	define('DAEMON_SENDS_DIGESTS', true);
-	// If update daemon and update_feeds should send digests
-	// Disable if you prefer querying special URL (see wiki)
+	// *********************************
+	// *** Email and digest settings ***
+	// *********************************
 
-	define('ENABLE_TRANSLATIONS', false);
-	// Enable experimental support for interface translations
-	// based on PHP-Gettext. This is of no much use right now.
-
-	define('MYSQL_CHARSET', '');
-	// Connection charset for MySQL. Only enable if having charset-related
-	// errors with MySQL (mangled characters, errors when updating feeds, etc).
-
-	define('ENABLE_SIMPLEPIE', false);
-	// Enables SimplePie RSS parsing library (experimental). When this option 
-	// is disabled, Tiny Tiny RSS defaults to Magpie library. 
-
-	// SimplePie is somewhat faster, more robust and less clunky as Magpie. 
-	// While it doesn't internally support HTTP Digest authentication 
-	// (required for Livejournal protected feeds and such) and SSL, it can
-	// support it when using CURL.
-
-	// To summarize, if your PHP has CURL extension or you aren't subscribed
-	// to any feeds using HTTP Digest authentication and Magpie XML parsing 
-	// errors are bothering you too much, you can try enabling SimplePie.
-
-	define('SIMPLEPIE_CACHE_DIR',	'/var/tmp/simplepie-ttrss-cache');
-	// Cache directory for RSS feeds when using SimplePie
-
-	define('SIMPLEPIE_CACHE_IMAGES', false);
-	// Allow caching feed images when using SimplePie, to bypass hotlink
-	// prevention and such at expense of local disk space and bandwidth.
-	// Note that you (or your users) also have to enable image caching 
-	// in feed editor.
-	
-	define('COUNTERS_MAX_AGE', 365);
-	// Hard limit for unread counters calculation. Try tweaking this
-	// parameter to speed up tt-rss when having a huge number of articles
-	// in the database (better yet, enable purging!)
-
-	define('DIGEST_FROM_NAME', 'Tiny Tiny RSS');
-	define('DIGEST_FROM_ADDRESS', 'noreply@your.domain.dom');
+	define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
+	define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
 	// Name, address and subject for sending outgoing mail. This applies
 	// to password reset notifications, digest emails and any other mail.
 
 	define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
 	// Subject line for email digests
 
-	define('DIGEST_SMTP_HOST', '');
+	define('SMTP_HOST', '');
 	// SMTP Host to send outgoing mail. Blank - use system MTA.
 
-	define('DIGEST_SMTP_LOGIN', '');
-	define('DIGEST_SMTP_PASSWORD', '');
+	define('SMTP_LOGIN', '');
+	define('SMTP_PASSWORD', '');
 	// These two options enable SMTP authentication when sending
-	// outgoing mail. Require DIGEST_SMTP_HOST.
-
-	define('DAEMON_FEED_LIMIT', 100);
-	// Limits the amount of feeds daemon (or a cronjob) updates on one run
-
-	define('ALLOW_REMOTE_USER_AUTH', false);
-   // Set to 'true' if you trust your web server's REMOTE_USER
-	// environment variable to validate that the user is logged in. This
-	// option can be used to integrate tt-rss with Apache's external
-	// authentication modules.
+	// outgoing mail. Only used with SMTP_HOST
 
-	define('LOCK_DIRECTORY', '.');
-	// Directory for lockfiles, must be writable to the user you run
-	// daemon process or cronjobs under.
+	// ***************************************
+	// *** Other settings (less important) ***
+	// ***************************************
 
-	define('ALLOW_SELECT_UPDATE_METHOD', true);
-	// Allow users to select the library to update feeds with - e.g.
-	// Magpie or SimplePie
+	define('CHECK_FOR_NEW_VERSION', true);
+	// Check for new versions of tt-rss automatically.
 
 	define('ENABLE_GZIP_OUTPUT', false);
 	// Selectively gzip output to improve wire performance. This requires
 	// PHP Zlib extension on the server.
+	// Enabling this can break tt-rss in several httpd/php configurations,
+	// if you experience weird errors and tt-rss failing to start, blank pages
+	// after login, or content encoding errors, disable it.
 
-	define('PHP_EXECUTABLE', '/usr/bin/php');
-	// Path to PHP executable
-
-	define('ENABLE_REGISTRATION', false);
-	// Allow users to register themselves. Please be vary 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.
+	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('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
-	// Email address to send new user notifications to.
-
-	define('REG_MAX_USERS', 10);
-	// Maximum amount of users which will be allowed to register on this
-	// system. 0 - no limit.
+	define('ARTICLE_BUTTON_PLUGINS', 'note,tweet,share,mail');
+	// Comma-separated list of additional article action button plugins
+	// to enable, like tweet button, etc.
+	// The following plugins are available: note, tweet, share, mail
+	// More plugins: http://tt-rss.org/wiki/Plugins
 
-	define('CONFIG_VERSION', 18);
+	define('CONFIG_VERSION', 26);
 	// Expected config version. Please update this option in config.php
 	// if necessary (after migrating all new options from this file).