]> git.wh0rd.org - tt-rss.git/blob - config.php-dist
Merge branch 'subscribe-idn-feed' into 'master'
[tt-rss.git] / 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 // *** PubSubHubbub settings ***
103
104 define('PUBSUBHUBBUB_HUB', '');
105 // URL to a PubSubHubbub-compatible hub server. If defined, "Published
106 // articles" generated feed would automatically become PUSH-enabled.
107
108 define('PUBSUBHUBBUB_ENABLED', false);
109 // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
110 // won't try to subscribe to PUSH feed updates.
111
112 // ****************************
113 // *** Sphinx search plugin ***
114 // ****************************
115
116 define('SPHINX_SERVER', 'localhost:9312');
117 // Hostname:port combination for the Sphinx server.
118
119 define('SPHINX_INDEX', 'ttrss, delta');
120 // Index name in Sphinx configuration. You can specify multiple indexes
121 // as a comma-separated string.
122 // Example configuration files are available on tt-rss wiki.
123
124 // ***********************************
125 // *** Self-registrations by users ***
126 // ***********************************
127
128 define('ENABLE_REGISTRATION', false);
129 // Allow users to register themselves. Please be aware that allowing
130 // random people to access your tt-rss installation is a security risk
131 // and potentially might lead to data loss or server exploit. Disabled
132 // by default.
133
134 define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
135 // Email address to send new user notifications to.
136
137 define('REG_MAX_USERS', 10);
138 // Maximum amount of users which will be allowed to register on this
139 // system. 0 - no limit.
140
141 // **********************************
142 // *** Cookies and login sessions ***
143 // **********************************
144
145 define('SESSION_COOKIE_LIFETIME', 86400);
146 // Default lifetime of a session (e.g. login) cookie. In seconds,
147 // 0 means cookie will be deleted when browser closes.
148
149 // *********************************
150 // *** Email and digest settings ***
151 // *********************************
152
153 define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
154 define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
155 // Name, address and subject for sending outgoing mail. This applies
156 // to password reset notifications, digest emails and any other mail.
157
158 define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
159 // Subject line for email digests
160
161 define('SMTP_SERVER', '');
162 // Hostname:port combination to send outgoing mail (i.e. localhost:25).
163 // Blank - use system MTA.
164
165 define('SMTP_LOGIN', '');
166 define('SMTP_PASSWORD', '');
167 // These two options enable SMTP authentication when sending
168 // outgoing mail. Only used with SMTP_SERVER.
169
170 define('SMTP_SECURE', '');
171 // Used to select a secure SMTP connection. Allowed values: ssl, tls,
172 // or empty.
173
174 // ***************************************
175 // *** Other settings (less important) ***
176 // ***************************************
177
178 define('CHECK_FOR_UPDATES', true);
179 // Check for updates automatically if running Git version
180
181 define('ENABLE_GZIP_OUTPUT', false);
182 // Selectively gzip output to improve wire performance. This requires
183 // PHP Zlib extension on the server.
184 // Enabling this can break tt-rss in several httpd/php configurations,
185 // if you experience weird errors and tt-rss failing to start, blank pages
186 // after login, or content encoding errors, disable it.
187
188 define('PLUGINS', 'auth_internal, note');
189 // Comma-separated list of plugins to load automatically for all users.
190 // System plugins have to be specified here. Please enable at least one
191 // authentication plugin here (auth_*).
192 // Users may enable other user plugins from Preferences/Plugins but may not
193 // disable plugins specified in this list.
194 // Disabling auth_internal in this list would automatically disable
195 // reset password link on the login form.
196
197 define('LOG_DESTINATION', 'sql');
198 // Log destination to use. Possible values: sql (uses internal logging
199 // you can read in Preferences -> System), syslog - logs to system log.
200 // Setting this to blank uses PHP logging (usually to http server
201 // error.log).
202
203 define('CONFIG_VERSION', 26);
204 // Expected config version. Please update this option in config.php
205 // if necessary (after migrating all new options from this file).
206
207 // vim:ft=php