config: replace confusing option ENABLE_SIMPLEPIE with DEFAULT_UPDATE_METHOD; bump...

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

<?php
	// Your RDBMS must be configured to accept connections
	// via TCP/IP and authentified by password.

	define('DB_TYPE', "pgsql"); // or mysql
	define('DB_HOST', "localhost");
	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('MAGPIE_CACHE_AGE', 60*30); 
	// How long to store cached RSS objects? In seconds.
	// Defaults to 30 minutes

	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.
	// 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('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 (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

	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('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', '');
	// Connection charset for MySQL. Only enable if having charset-related
	// errors with MySQL (mangled characters, errors when updating feeds, etc).

	define('DEFAULT_UPDATE_METHOD', 0);
	// Which feed parsing library to use as default:
	// 0 - Magpie
	// 1 - 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');
	// 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', '.');
	// Directory for lockfiles, must be writable to the user you run
	// daemon process or cronjobs under.

	define('ALLOW_SELECT_UPDATE_METHOD', true);
	// Allow users to select the library to update feeds with - e.g.
	// Magpie or SimplePie

	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('CONFIG_VERSION', 19);
	// Expected config version. Please update this option in config.php
	// if necessary (after migrating all new options from this file).

	// vim:ft=php
?>