config.php-dist

   1 <?php
   2         // *******************************************
   3         // *** Database configuration (important!) ***
   4         // *******************************************
   5
   6         define('DB_TYPE', "pgsql"); // or mysql
   7         define('DB_HOST', "localhost");
   8         define('DB_USER', "fox");
   9         define('DB_NAME', "fox");
  10         define('DB_PASS', "XXXXXX");
  11         define('DB_PORT', ''); // usually 5432 for PostgreSQL, 3306 for MySQL
  12
  13         define('MYSQL_CHARSET', 'UTF8');
  14         // Connection charset for MySQL. If you have a legacy database and/or experience
  15         // garbage unicode characters with this option, try setting it to a blank string.
  16
  17         // ***********************************
  18         // *** Basic settings (important!) ***
  19         // ***********************************
  20
  21         define('SELF_URL_PATH', 'http://example.org/tt-rss/');
  22         // Full URL of your tt-rss installation. This should be set to the
  23         // location of tt-rss directory, e.g. http://example.org/tt-rss/
  24         // You need to set this option correctly otherwise several features
  25         // including PUSH, bookmarklets and browser integration will not work properly.
  26
  27         define('FEED_CRYPT_KEY', '');
  28         // Key used for encryption of passwords for password-protected feeds
  29         // in the database. A string of 24 random characters. If left blank, encryption
  30         // is not used. Requires mcrypt functions.
  31         // Warning: changing this key will make your stored feed passwords impossible
  32         // to decrypt.
  33
  34         define('SINGLE_USER_MODE', false);
  35         // Operate in single user mode, disables all functionality related to
  36         // multiple users and authentication. Enabling this assumes you have
  37         // your tt-rss directory protected by other means (e.g. http auth).
  38
  39         define('SIMPLE_UPDATE_MODE', false);
  40         // Enables fallback update mode where tt-rss tries to update feeds in
  41         // background while tt-rss is open in your browser.
  42         // If you don't have a lot of feeds and don't want to or can't run
  43         // background processes while not running tt-rss, this method is generally
  44         // viable to keep your feeds up to date.
  45         // Still, there are more robust (and recommended) updating methods
  46         // available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
  47
  48         // *****************************
  49         // *** Files and directories ***
  50         // *****************************
  51
  52         define('PHP_EXECUTABLE', '/usr/bin/php');
  53         // Path to PHP *COMMAND LINE* executable, used for various command-line tt-rss
  54         // programs and update daemon. Do not try to use CGI binary here, it won't work.
  55         // If you see HTTP headers being displayed while running tt-rss scripts,
  56         // then most probably you are using the CGI binary. If you are unsure what to
  57         // put in here, ask your hosting provider.
  58
  59         define('LOCK_DIRECTORY', 'lock');
  60         // Directory for lockfiles, must be writable to the user you run
  61         // daemon process or cronjobs under.
  62
  63         define('CACHE_DIR', 'cache');
  64         // Local cache directory for RSS feed content.
  65
  66         define('ICONS_DIR', "feed-icons");
  67         define('ICONS_URL', "feed-icons");
  68         // Local and URL path to the directory, where feed favicons are stored.
  69         // Unless you really know what you're doing, please keep those relative
  70         // to tt-rss main directory.
  71
  72         // **********************
  73         // *** Authentication ***
  74         // **********************
  75
  76         // Please see PLUGINS below to configure various authentication modules.
  77
  78         define('AUTH_AUTO_CREATE', true);
  79         // Allow authentication modules to auto-create users in tt-rss internal
  80         // database when authenticated successfully.
  81
  82         define('AUTH_AUTO_LOGIN', true);
  83         // Automatically login user on remote or other kind of externally supplied
  84         // authentication, otherwise redirect to login form as normal.
  85         // If set to true, users won't be able to set application language
  86         // and settings profile.
  87
  88         // *********************
  89         // *** Feed settings ***
  90         // *********************
  91
  92         define('FORCE_ARTICLE_PURGE', 0);
  93         // When this option is not 0, users ability to control feed purging
  94         // intervals is disabled and all articles (which are not starred)
  95         // older than this amount of days are purged.
  96
  97         // *** PubSubHubbub settings ***
  98
  99         define('PUBSUBHUBBUB_HUB', '');
 100         // URL to a PubSubHubbub-compatible hub server. If defined, "Published
 101         // articles" generated feed would automatically become PUSH-enabled.
 102
 103         define('PUBSUBHUBBUB_ENABLED', false);
 104         // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
 105         // won't try to subscribe to PUSH feed updates.
 106
 107         // ****************************
 108         // *** Sphinx search plugin ***
 109         // ****************************
 110
 111         define('SPHINX_SERVER', 'localhost:9312');
 112         // Hostname:port combination for the Sphinx server.
 113
 114         define('SPHINX_INDEX', 'ttrss, delta');
 115         // Index name in Sphinx configuration. You can specify multiple indexes
 116         // as a comma-separated string.
 117         // Example configuration files are available on tt-rss wiki.
 118
 119         // ***********************************
 120         // *** Self-registrations by users ***
 121         // ***********************************
 122
 123         define('ENABLE_REGISTRATION', false);
 124         // Allow users to register themselves. Please be aware that allowing
 125         // random people to access your tt-rss installation is a security risk
 126         // and potentially might lead to data loss or server exploit. Disabled
 127         // by default.
 128
 129         define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
 130         // Email address to send new user notifications to.
 131
 132         define('REG_MAX_USERS', 10);
 133         // Maximum amount of users which will be allowed to register on this
 134         // system. 0 - no limit.
 135
 136         // **********************************
 137         // *** Cookies and login sessions ***
 138         // **********************************
 139
 140         define('SESSION_COOKIE_LIFETIME', 86400);
 141         // Default lifetime of a session (e.g. login) cookie. In seconds,
 142         // 0 means cookie will be deleted when browser closes.
 143
 144         define('SESSION_CHECK_ADDRESS', 1);
 145         // Check client IP address when validating session:
 146         // 0 - disable checking
 147         // 1 - check first 3 octets of an address (recommended)
 148         // 2 - check first 2 octets of an address
 149         // 3 - check entire address
 150
 151         // *********************************
 152         // *** Email and digest settings ***
 153         // *********************************
 154
 155         define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
 156         define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
 157         // Name, address and subject for sending outgoing mail. This applies
 158         // to password reset notifications, digest emails and any other mail.
 159
 160         define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
 161         // Subject line for email digests
 162
 163         define('SMTP_SERVER', '');
 164         // Hostname:port combination to send outgoing mail (i.e. localhost:25).
 165         // Blank - use system MTA.
 166
 167         define('SMTP_LOGIN', '');
 168         define('SMTP_PASSWORD', '');
 169         // These two options enable SMTP authentication when sending
 170         // outgoing mail. Only used with SMTP_SERVER.
 171
 172         define('SMTP_SECURE', '');
 173         // Used to select a secure SMTP connection. Allowed values: ssl, tls,
 174         // or empty.
 175
 176         // ***************************************
 177         // *** Other settings (less important) ***
 178         // ***************************************
 179
 180         define('CHECK_FOR_UPDATES', true);
 181         // Check for updates automatically if running Git version
 182
 183         define('DETECT_ARTICLE_LANGUAGE', false);
 184         // Detect article language when updating feeds, presently this is only
 185         // used for hyphenation. This may increase amount of CPU time used by
 186         // update processes, disable if necessary (i.e. you are being billed
 187         // for CPU time).
 188
 189         define('ENABLE_GZIP_OUTPUT', false);
 190         // Selectively gzip output to improve wire performance. This requires
 191         // PHP Zlib extension on the server.
 192         // Enabling this can break tt-rss in several httpd/php configurations,
 193         // if you experience weird errors and tt-rss failing to start, blank pages
 194         // after login, or content encoding errors, disable it.
 195
 196         define('PLUGINS', 'auth_internal, note');
 197         // Comma-separated list of plugins to load automatically for all users.
 198         // System plugins have to be specified here. Please enable at least one
 199         // authentication plugin here (auth_*).
 200         // Users may enable other user plugins from Preferences/Plugins but may not
 201         // disable plugins specified in this list.
 202         // Disabling auth_internal in this list would automatically disable
 203         // reset password link on the login form.
 204
 205         define('LOG_DESTINATION', 'sql');
 206         // Log destination to use. Possible values: sql (uses internal logging
 207         // you can read in Preferences -> System), syslog - logs to system log.
 208         // Setting this to blank uses PHP logging (usually to http server
 209         // error.log).
 210
 211         define('CONFIG_VERSION', 26);
 212         // Expected config version. Please update this option in config.php
 213         // if necessary (after migrating all new options from this file).
 214
 215         // vim:ft=php