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