diff options
Diffstat (limited to 'config.php-dist')
-rw-r--r-- | config.php-dist | 225 |
1 files changed, 120 insertions, 105 deletions
diff --git a/config.php-dist b/config.php-dist index 4e231a6f0..e4b5ae32d 100644 --- a/config.php-dist +++ b/config.php-dist @@ -1,5 +1,8 @@ <?php - // Database server configuration + // ******************************************* + // *** Database configuration (important!) *** + // ******************************************* + define('DB_TYPE', "pgsql"); // or mysql define('DB_HOST', "localhost"); define('DB_USER', "fox"); @@ -7,24 +10,40 @@ define('DB_PASS', "XXXXXX"); //define('DB_PORT', '5432'); // when neeeded, PG-only + 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. + + // *********************************** + // *** Basic settings (important!) *** + // *********************************** + 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('SINGLE_USER_MODE', true); + define('SINGLE_USER_MODE', false); // Operate in single user mode, disables all functionality related to // multiple users. - + + // ***************************** + // *** Files and directories *** + // ***************************** + + define('PHP_EXECUTABLE', '/usr/bin/php'); + // Path to PHP executable, used for various command-line tt-rss programs + + 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('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('TMP_DIRECTORY', '/tmp'); + // Directory for temporary files define('ICONS_DIR', "feed-icons"); define('ICONS_URL', "feed-icons"); @@ -32,82 +51,51 @@ // Unless you really know what you're doing, please keep those relative // to tt-rss main directory. - define('TMP_DIRECTORY', '/tmp'); - // Directory for temporary files - - 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. + // ********************* + // *** Feed settings *** + // ********************* - 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('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 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('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('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('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('DEFAULT_UPDATE_METHOD', 0); // Which feed parsing library to use as default: // 0 - Magpie // 1 - SimplePie - 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('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('DIGEST_FROM_NAME', 'Tiny Tiny RSS'); - define('DIGEST_FROM_ADDRESS', '[email protected]'); - // Name, address and subject for sending outgoing mail. This applies - // to password reset notifications, digest emails and any other mail. + // *** PubSubHubbub settings *** - define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours'); - // Subject line for email digests + define('PUBSUBHUBBUB_HUB', ''); + // URL to a PubSubHubbub-compatible hub server. If defined, "Published + // articles" generated feed would automatically become PUSH-enabled. - define('DIGEST_SMTP_HOST', ''); - // SMTP Host to send outgoing mail. Blank - use system MTA. + define('PUBSUBHUBBUB_ENABLED', true); + // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss + // won't try to subscribe to PUSH feed updates. - define('DIGEST_SMTP_LOGIN', ''); - define('DIGEST_SMTP_PASSWORD', ''); - // These two options enable SMTP authentication when sending - // outgoing mail. Require DIGEST_SMTP_HOST. + // ********************* + // *** 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('DAEMON_FEED_LIMIT', 100); - // Limits the amount of feeds daemon (or a cronjob) updates on one run + define('SPHINX_INDEX', 'ttrss'); + // Index name in Sphinx configuration. You can specify multiple indexes + // as a comma-separated string. + + // ********************** + // *** Authentication *** + // ********************** define('ALLOW_REMOTE_USER_AUTH', false); // Set to 'true' if you trust your web server's REMOTE_USER @@ -127,16 +115,9 @@ // You want new users to be automaticaly created in tt-rss database // on first login - 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 + // *********************************** + // *** Self-registrations by users *** + // *********************************** define('ENABLE_REGISTRATION', false); // Allow users to register themselves. Please be vary that allowing @@ -151,23 +132,49 @@ // 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. + // ********************************** + // *** 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. - 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 - 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('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('SPHINX_INDEX', 'ttrss'); - // Index name in Sphinx configuration. You can specify multiple indexes - // as a comma-separated string. + // ********************************* + // *** Email and digest settings *** + // ********************************* + define('SMTP_FROM_NAME', 'Tiny Tiny RSS'); + define('SMTP_FROM_ADDRESS', '[email protected]'); + // 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('SMTP_HOST', ''); + // SMTP Host to send outgoing mail. Blank - use system MTA. + + define('SMTP_LOGIN', ''); + define('SMTP_PASSWORD', ''); + // These two options enable SMTP authentication when sending + // outgoing mail. Only used with SMTP_HOST + + // ************************************ + // *** Twitter integration settings *** + // ************************************ + define('ENABLE_TWEET_BUTTON', false); // Enable 'tweet this' button for articles @@ -176,19 +183,27 @@ // Your OAuth instance authentication information for Twitter, visit // http://twitter.com/oauth_clients to register your instance. - define('PUBSUBHUBBUB_HUB', ''); - // URL to a PubSubHubbub-compatible hub server. If defined, "Published - // articles" generated feed would automatically become PUSH-enabled. + // *************************************** + // *** Other settings (less important) *** + // *************************************** - define('PUBSUBHUBBUB_ENABLED', true); - // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss - // won't try to subscribe to PUSH feed updates. + define('CHECK_FOR_NEW_VERSION', true); + // Check for new versions of tt-rss automatically. + + 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('ISCONFIGURED', false); - // Please set this to true if you have read everything above and - // finished setting configuration options. + define('ENABLE_GZIP_OUTPUT', false); + // Selectively gzip output to improve wire performance. This requires + // PHP Zlib extension on the server. - define('CONFIG_VERSION', 23); + 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('CONFIG_VERSION', 24); // Expected config version. Please update this option in config.php // if necessary (after migrating all new options from this file). |