<?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('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");
+ 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('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('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 (e.g. login) cookie. In seconds,
- // 0 means cookie will be deleted when browser closes.
+ // **********************
+ // *** Authentication ***
+ // **********************
- define('SESSION_EXPIRE_TIME', 86400);
- // Hard expiration limit for sessions. Should be
- // greater or equal to SESSION_COOKIE_LIFETIME
+ // Please see PLUGINS below to configure various authentication modules.
- define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
- // Stop updating feeds of user who was never logged in
- // in specified amount of days. 0 disables.
+ define('AUTH_AUTO_CREATE', true);
+ // Allow authentication modules to auto-create users in tt-rss internal
+ // database when authenticated successfully.
- define('CHECK_FOR_NEW_VERSION', true);
- // Check for new versions of tt-rss when entering preferences.
+ 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('USE_CURL_FOR_ICONS', false);
- // Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
+ // *********************
+ // *** Feed settings ***
+ // *********************
- define('DIGEST_ENABLE', true);
- // Global option to enable daily digests
+ 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_HOSTNAME', 'some.ttrss.host.dom');
- // Hostname for email digest signature
+ // ****************************
+ // *** Sphinx search plugin ***
+ // ****************************
- define('DIGEST_EMAIL_LIMIT', 10);
- // The maximum amount of emails sent in one digest batch
+ define('SPHINX_SERVER', 'localhost:9312');
+ // Hostname:port combination for the Sphinx server.
- define('DAEMON_SENDS_DIGESTS', true);
- // If update daemon and update_feeds should send digests
- // Disable if you prefer querying special URL (see wiki)
+ 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('ENABLE_TRANSLATIONS', false);
- // Enable experimental support for interface translations
- // based on PHP-Gettext. This is of no much use right now.
+ // ***********************************
+ // *** Self-registrations by users ***
+ // ***********************************
- define('MYSQL_CHARSET', '');
- // Connection charset for MySQL. Only enable if having charset-related
- // errors with MySQL (mangled characters, errors when updating feeds, etc).
+ 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('ENABLE_SIMPLEPIE', false);
- // Enables SimplePie RSS parsing library (experimental). When this option
- // is disabled, Tiny Tiny RSS defaults to Magpie library.
+ define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
+ // Email address to send new user notifications to.
- // SimplePie is somewhat faster, more robust and less clunky as Magpie.
- // While it doesn't internally support HTTP Digest authentication
- // (required for Livejournal protected feeds and such) and SSL, it can
- // support it when using CURL.
+ define('REG_MAX_USERS', 10);
+ // Maximum amount of users which will be allowed to register on this
+ // system. 0 - no limit.
- // To summarize, if your PHP has CURL extension or you aren't subscribed
- // to any feeds using HTTP Digest authentication and Magpie XML parsing
- // errors are bothering you too much, you can try enabling SimplePie.
+ // **********************************
+ // *** Cookies and login sessions ***
+ // **********************************
- 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('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('CONFIG_VERSION', 9);
+ // *********************************
+ // *** Email and digest settings ***
+ // *********************************
+
+ // Tiny Tiny RSS sends mail via PHP mail() function, unless handled
+ // by a plugin.
+
+ // If you need SMTP support, take a look here:
+ // https://git.tt-rss.org/fox/ttrss-mailer-smtp
+
+ 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.
+
+ // ***************************************
+ // *** Other settings (less important) ***
+ // ***************************************
+
+ 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.
+ // 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
-?>
git.wh0rd.org / tt-rss.git / blobdiff