X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=config.php-dist;h=824b843c7719bc6312101eef1d1ecc39a09daaa9;hb=dcb38ced56c33463bb55f266b2d586308ff12b2f;hp=94437041aa825f64fc48bcbae896eddc51865cd3;hpb=2ab29ac6015db16c82245091d5419ad2143742af;p=tt-rss.git

diff --git a/config.php-dist b/config.php-dist
index 94437041..824b843c 100644
--- 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.
 
@@ -9,115 +9,179 @@
 	define('DB_PASS', "XXXXXX");
 	//define('DB_PORT', '5432'); // when neeeded, PG-only
 
-	define('MAGPIE_CACHE_DIR', '/var/tmp/magpie-ttrss-cache');
+	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', 'cache/magpie');
 	// Local cache directory for RSS feeds
-	
-	define('WEB_DEMO_MODE', false);
-	// Demo mode with reduced functionality.
+
+	define('MAGPIE_CACHE_AGE', 60*30); 
+	// How long to store cached RSS objects? In seconds.
+	// Defaults to 30 minutes
 
 	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.
+	// Unless you really know what you're doing, please keep those relative
+	// to tt-rss main directory.
 
 	define('SINGLE_USER_MODE', true);
 	// Operate in single user mode, disables all functionality related to
 	// multiple users.
-
-	define('DAEMON_REFRESH_ONLY', false);
-	// updates to all feeds will only run when the backend script is
-	// invoked with a "daemon" option on the URI stem. This is useful when you
-	// are hosting multi-user system and want to control how often 
-	// feeds are being updated.
-	
-	// An example wget command line below will invoke an update every 30 
-	// minutes, with output being sent to /dev/null and the timeout set to 
-	// 10 minutes so that wget does not time out. Substitute your site name
-	// and tt-rss path as necessary.
-	//
-	// */30 * * * * /usr/bin/wget -O /dev/null -T 600 "http://www.your-site.xxx/tt-rss/backend.php?op=globalUpdateFeeds&daemon=1"
-	//
-
-	// The alternative approach is to run update_feeds.php from your crontab
-	// with command line PHP interpreter. Don't forget to chdir() into TT-RSS
-	// 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
-	// 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('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('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('DISABLE_SESSIONS', false);
-	// Never enable this option (kludge for daemon using tt-rss code)
-
 	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. Uses default PHP session storing mechanism if disabled
+	// 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.
+	// 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
-	// >= SESSION_COOKIE_LIFETIME_REMEMBER
+	// greater or equal to SESSION_COOKIE_LIFETIME
+
+	define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
+	// Stop updating feeds of user who haven't logged in specified 
+	// amount of days. 0 disables.
+
+	define('CHECK_FOR_NEW_VERSION', true);
+	// Check for new versions of tt-rss automatically.
+
+	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. Also toggles the ability of users
+	// to forward articles by email.
+
+	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('ENABLE_TRANSLATIONS', true);
+	// Enable support for interface translations
+
+	define('MYSQL_CHARSET', 'UTF8');
+	// Connection charset for MySQL.
+
+	define('DEFAULT_UPDATE_METHOD', 0);
+	// Which feed parsing library to use as default:
+	// 0 - Magpie
+	// 1 - SimplePie
+
+	define('SIMPLEPIE_CACHE_DIR',	'cache/simplepie');
+	// 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');
+	// 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', '');
+	// SMTP Host to send outgoing mail. Blank - use system MTA.
+
+	define('DIGEST_SMTP_LOGIN', '');
+	define('DIGEST_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.
+
+	define('LOCK_DIRECTORY', 'lock');
+	// Directory for lockfiles, must be writable to the user you run
+	// daemon process or cronjobs under.
+
+	define('ENABLE_GZIP_OUTPUT', false);
+	// Selectively gzip output to improve wire performance. This requires
+	// PHP Zlib extension on the server.
+
+	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('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('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('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.
+
+	define('SPHINX_ENABLE', 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
+
+	define('ENABLE_TWEET_BUTTON', false);
+	// Enable 'tweet this' button for articles
+
+	define('CONSUMER_KEY', '');
+	define('CONSUMER_SECRET', '');
+	// Your OAuth instance authentication information for Twitter, visit
+	// http://twitter.com/oauth_clients to register your instance.
+
+	define('CONFIG_VERSION', 20);
+	// Expected config version. Please update this option in config.php
+	// if necessary (after migrating all new options from this file).
 
 	// vim:ft=php
 ?>