X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=config.php-dist;h=3f12ba4393435d33941b9a8e50768a393bb1ae75;hb=afad6f38e4ba03c8f1e6fdb6a6a81f2f1afd125a;hp=6ffcbe8a15b941e73d0c64e095365bc8d7bace66;hpb=0d43b92104ae4fd0eb236b3b9b2e08b3c9fa5697;p=tt-rss.git

diff --git a/config.php-dist b/config.php-dist
index 6ffcbe8a..3f12ba43 100644
--- a/config.php-dist
+++ b/config.php-dist
@@ -1,72 +1,161 @@
-<?
-	// PostgreSQL must be configured to accept connections
+<?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_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('RSS_BACKEND_TYPE', "magpie");
+	// magpie (stable) or simplepie (EXPERIMENTAL!)
+
+	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);
-	
-	define(ENABLE_FEED_ICONS, true);	
-	define(ICONS_DIR, "icons");
-	define(ICONS_URL, "icons");
-	
-	define(PURGE_OLD_DAYS, 30);
-	// Articles older than this number of days will be deleted automatically
-	
-	define(UPDATE_POST_ON_CHECKSUM_CHANGE, true);
-	
-	define(ENABLE_PREFS_CATCHUP_UNCATCHUP, false);
-	// enable "Mark as read/unread" buttons in preferences dialog
-
-	define(ENABLE_LABELS, false);
-	// experimental support for virtual feeds or labels based on user
-	// crafted SQL queries. This feature is highly experimental and
-	// at this point not user friendly. Use with caution.
-
-	define(DEFAULT_ARTICLE_LIMIT, 0);
-	// default limit for articles to display. Set to 0 for no limit. Not
-	// limited to the default 15, 30, 60 article limits - you may use
-	// any number you want and it will be added to the list. Negative
-	// numbers will be ignored. Anything that evaluates numerically to
-	// zero will be interpreted as 0.
-
-	define(DEFAULT_UPDATE_INTERVAL, 30);
-	// default interval between feed updates, minutes
-
- 	define(DISPLAY_HEADER, true);
- 	// enable/disable the display of the header graphic
- 
- 	define(DISPLAY_FOOTER, true);
- 	// enable/disable the display of the footer
-
-	define(USE_COMPACT_STYLESHEET, false);
-	// use stylesheet with more compact layout (if combined with two previous 
-	// options may improve UI on small screens)
-
-	define(DAEMON_REFRESH_ONLY, false);
+
+	define('SIMPLEPIE_CACHE_DIR',	'/var/tmp/simplepie-ttrss-cache');
+	// Local cache directory for RSS feeds (simplepie)
+
+	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.
+
+	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. 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, tt-rss
-	// path, and username/password as necessary.
+	// 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"
 	//
-	// */30 * * * * /usr/bin/wget -O /dev/null -T 600 "http://username:password@www.your-site.xxx/tt-rss/backend.php?op=updateAllFeeds&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
 
-	define(DISPLAY_FEEDLIST_ACTIONS, false);
-	// display actions dropbox in feedlist, if disabled these actions are
-	// available in the global actions dropbox
+	// 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(ENABLE_SPLASH, false);
-	// enable splashscreen on loading
+	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@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', 5);
+	// Expected config version. Please update this option in config.php
+	// if necessary (after migrating all new options from this file).
+
+	// vim:ft=php
+?>