X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=config.php-dist;h=a8817fae7964ab86223a1a1d581bf75edefea1ee;hb=81fc862e370a1dfbd3941206fd00076e3cbf0551;hp=fb9a28bcda142084655103a0dd42811520380a4f;hpb=4bb6b8ea2c4a2d2a6d9c2302a75e62862b771499;p=tt-rss.git

diff --git a/config.php-dist b/config.php-dist
old mode 100644
new mode 100755
index fb9a28bc..a8817fae
--- a/config.php-dist
+++ b/config.php-dist
@@ -1,175 +1,181 @@
 <?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");
 	define('DB_USER', "fox");
 	define('DB_NAME', "fox");
 	define('DB_PASS', "XXXXXX");
-	//define('DB_PORT', '5432'); // when neeeded, PG-only
+	define('DB_PORT', ''); // usually 5432 for PostgreSQL, 3306 for MySQL
 
-	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://example.org/tt-rss/');
+	// Full URL of your tt-rss installation. This should be set to the
+	// location of tt-rss directory, e.g. http://example.org/tt-rss/
+	// You need to set this option correctly otherwise several features
+	// including PUSH, bookmarklets and browser integration will not work properly.
 
-	define('ICONS_DIR', "icons");
-	define('ICONS_URL', "icons");
+	define('SINGLE_USER_MODE', false);
+	// Operate in single user mode, disables all functionality related to
+	// multiple users and authentication. Enabling this assumes you have
+	// your tt-rss directory protected by other means (e.g. http auth).
+
+	define('SIMPLE_UPDATE_MODE', false);
+	// Enables fallback update mode where tt-rss tries to update feeds in
+	// background while tt-rss is open in your browser.
+	// If you don't have a lot of feeds and don't want to or can't run
+	// background processes while not running tt-rss, this method is generally
+	// viable to keep your feeds up to date.
+	// Still, there are more robust (and recommended) updating methods
+	// available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
+
+	// *****************************
+	// *** Files and directories ***
+	// *****************************
+
+	define('PHP_EXECUTABLE', '/usr/bin/php');
+	// Path to PHP *COMMAND LINE* executable, used for various command-line tt-rss
+	// programs and update daemon. Do not try to use CGI binary here, it won't work.
+	// If you see HTTP headers being displayed while running tt-rss scripts,
+	// then most probably you are using the CGI binary. If you are unsure what to
+	// put in here, ask your hosting provider.
+
+	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('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.
 
-	define('SINGLE_USER_MODE', true);
-	// Operate in single user mode, disables all functionality related to
-	// multiple users.
-	
-	define('TMP_DIRECTORY', '/tmp');
-	// Directory for temporary files
-
-	define('FEEDS_FRAME_REFRESH', 600);
-	// Auto refresh interval for feeds frame (in seconds)
+	// **********************
+	// *** Authentication ***
+	// **********************
 
-	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).
+	// Please see PLUGINS below to configure various authentication modules.
 
-	define('DAEMON_SLEEP_INTERVAL', 120);
-	// Interval between update daemon update runs
+	define('AUTH_AUTO_CREATE', true);
+	// Allow authentication modules to auto-create users in tt-rss internal
+	// database when authenticated successfully.
 
-	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('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.
 
-	define('SESSION_CHECK_ADDRESS', true);
-	// Bind session to client IP address (recommended)
+	// *********************
+	// *** Feed settings ***
+	// *********************
 
-	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('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('SESSION_EXPIRE_TIME', 86400);
-	// Hard expiration limit for sessions. Should be
-	// greater or equal to SESSION_COOKIE_LIFETIME
+	// ****************************
+	// *** Sphinx search plugin ***
+	// ****************************
 
-	define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
-	// Stop updating feeds of user who haven't logged in specified 
-	// amount of days. 0 disables.
+	define('SPHINX_SERVER', 'localhost:9312');
+	// Hostname:port combination for the Sphinx server.
 
-	define('CHECK_FOR_NEW_VERSION', true);
-	// Check for new versions of tt-rss when entering preferences.
+	define('SPHINX_INDEX', 'ttrss, delta');
+	// Index name in Sphinx configuration. You can specify multiple indexes
+	// as a comma-separated string.
+	// Example configuration files are available on tt-rss wiki.
 
-	define('USE_CURL_FOR_ICONS', false);
-	// Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
+	// ***********************************
+	// *** Self-registrations by users ***
+	// ***********************************
 
-	define('DIGEST_ENABLE', true);
-	// Global option to enable daily digests
+	define('ENABLE_REGISTRATION', false);
+	// Allow users to register themselves. Please be aware 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('DIGEST_EMAIL_LIMIT', 10);
-	// The maximum amount of emails sent in one digest batch
+	define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
+	// Email address to send new user notifications to.
 
-	define('DAEMON_SENDS_DIGESTS', true);
-	// If update daemon and update_feeds should send digests
-	// Disable if you prefer querying special URL (see wiki)
+	define('REG_MAX_USERS', 10);
+	// Maximum amount of users which will be allowed to register on this
+	// system. 0 - no limit.
 
-	define('ENABLE_TRANSLATIONS', true);
-	// Enable support for interface translations
+	// **********************************
+	// *** Cookies and login sessions ***
+	// **********************************
 
-	define('MYSQL_CHARSET', '');
-	// Connection charset for MySQL. Only enable if having charset-related
-	// errors with MySQL (mangled characters, errors when updating feeds, etc).
+	define('SESSION_COOKIE_LIFETIME', 86400);
+	// Default lifetime of a session (e.g. login) cookie. In seconds,
+	// 0 means cookie will be deleted when browser closes.
 
-	define('DEFAULT_UPDATE_METHOD', 0);
-	// Which feed parsing library to use as default:
-	// 0 - Magpie
-	// 1 - SimplePie
+	// *********************************
+	// *** Email and digest settings ***
+	// *********************************
 
-	define('SIMPLEPIE_CACHE_DIR',	'/var/tmp/simplepie-ttrss-cache');
-	// Cache directory for RSS feeds when using SimplePie
+	// Tiny Tiny RSS sends mail via PHP mail() function, unless handled
+	// by a plugin.
 
-	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!)
+	// If you need SMTP support, take a look here:
+	// https://git.tt-rss.org/fox/ttrss-mailer-smtp
 
-	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
+	// Set this to false to disable digests entirely.
 
-	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.
+	// ***************************************
+	// *** Other settings (less important) ***
+	// ***************************************
 
-	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('CHECK_FOR_UPDATES', true);
+	// Check for updates automatically if running Git version
 
 	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);
+	// 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('PLUGINS', 'auth_internal, note');
+	// Comma-separated list of plugins to load automatically for all users.
+	// System plugins have to be specified here. Please enable at least one
+	// authentication plugin here (auth_*).
+	// Users may enable other user plugins from Preferences/Plugins but may not
+	// disable plugins specified in this list.
+	// Disabling auth_internal in this list would automatically disable
+	// reset password link on the login form.
+
+	define('LOG_DESTINATION', 'sql');
+	// Error log destination to use. Possible values: sql (uses internal logging
+	// you can read in Preferences -> System), syslog - logs to system log.
+	// Setting this to blank uses PHP logging (usually to http server
+	// error.log).
+	// Note that feed updating daemons don't use this logging facility
+	// for normal output.
+
+	define('CONFIG_VERSION', 26);
 	// Expected config version. Please update this option in config.php
 	// if necessary (after migrating all new options from this file).
 
 	// vim:ft=php
-?>