]> git.wh0rd.org - tt-rss.git/blame - config.php-dist
htmlpurifier: suppress HTML.Allowed deprecation warning
[tt-rss.git] / config.php-dist
CommitLineData
20862e58 1<?php
8b2cbc33 2 // Your RDBMS must be configured to accept connections
f92db4f5 3 // via TCP/IP and authentified by password.
648472a7 4
cce28758
AD
5 define('DB_TYPE', "pgsql"); // or mysql
6 define('DB_HOST', "localhost");
7 define('DB_USER', "fox");
8 define('DB_NAME', "fox");
9 define('DB_PASS', "XXXXXX");
befc807f 10 //define('DB_PORT', '5432'); // when neeeded, PG-only
648472a7 11
ed102aa0
AD
12 define('SELF_URL_PATH', 'http://localhost/tt-rss');
13 // Full URL of your tt-rss installation. You need to set this option
14 // correctly for tt-rss to function properly.
15
baef3dfe
AD
16 define('MAGPIE_FETCH_TIME_OUT', 60);
17 // Magpie's default timeout is 5 seconds. Some RSS feeds,
18 // such as from large Trac installs, can take significantly
19 // longer than 5 seconds to generate. To prevent failed
20 // updates, increase this.
21
2aae0cce 22 define('MAGPIE_CACHE_DIR', 'cache/magpie');
f92db4f5 23 // Local cache directory for RSS feeds
7c5a308d 24
cce28758
AD
25 define('ICONS_DIR', "icons");
26 define('ICONS_URL', "icons");
56a2fd35 27 // Local and URL path to the directory, where feed favicons are stored.
15ea0691
AD
28 // Unless you really know what you're doing, please keep those relative
29 // to tt-rss main directory.
535d216a
AD
30 // Please note that Apache may reserve /icons/ URL to itself so you might
31 // need to change this and rename icons/ directory if you install tt-rss
32 // into website root.
c8437f35 33
cce28758 34 define('SINGLE_USER_MODE', true);
8b2cbc33
AD
35 // Operate in single user mode, disables all functionality related to
36 // multiple users.
a47a3f82 37
7d7cbaf5
AD
38 define('TMP_DIRECTORY', '/tmp');
39 // Directory for temporary files
f5de0d8d 40
78ea1de0
AD
41 define('DAEMON_SLEEP_INTERVAL', 120);
42 // Interval between update daemon update runs
43
03f321db 44 define('DATABASE_BACKED_SESSIONS', false);
2ab29ac6 45 // Store session information in a database, recommended for multiuser
5854b016
AD
46 // configurations. Doesn't seem to work for everyone, so enable with caution.
47 // tt-rss uses default PHP session storing mechanism if disabled.
8fd92701 48
0f41fce8
AD
49 define('SESSION_CHECK_ADDRESS', 1);
50 // Check client IP address when validating session:
51 // 0 - disable checking
52 // 1 - check first 3 octets of an address (recommended)
53 // 2 - check first 2 octets of an address
54 // 3 - check entire address
09018e95 55
377a3e8b 56 define('SESSION_COOKIE_LIFETIME', 0);
f7c390b8
AD
57 // Default lifetime of a session (e.g. login) cookie. In seconds,
58 // 0 means cookie will be deleted when browser closes.
898a9cdb
AD
59
60 define('SESSION_EXPIRE_TIME', 86400);
61 // Hard expiration limit for sessions. Should be
f7c390b8 62 // greater or equal to SESSION_COOKIE_LIFETIME
898a9cdb 63
5f2cd401 64 define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
4bb6b8ea
AD
65 // Stop updating feeds of user who haven't logged in specified
66 // amount of days. 0 disables.
eed55fd3 67
b72c3ef8 68 define('CHECK_FOR_NEW_VERSION', true);
0ff6e252 69 // Check for new versions of tt-rss automatically.
b72c3ef8 70
1ddba275 71 define('DIGEST_ENABLE', true);
31a53903
AD
72 // Global option to enable daily digests. Also toggles the ability of users
73 // to forward articles by email.
1ddba275 74
9cd7c995
AD
75 define('DIGEST_EMAIL_LIMIT', 10);
76 // The maximum amount of emails sent in one digest batch
77
99018440
AD
78 define('DAEMON_SENDS_DIGESTS', true);
79 // If update daemon and update_feeds should send digests
80 // Disable if you prefer querying special URL (see wiki)
81
8e54a21e 82 define('MYSQL_CHARSET', 'UTF8');
80dce75e
AD
83 // Connection charset for MySQL. If you have a legacy database and/or experience
84 // garbage unicode characters with this option, try setting it to a blank string.
bddc9788 85
91149aab 86 define('DEFAULT_UPDATE_METHOD', 0);
78a5c296
AD
87 // Which feed parsing library to use as default:
88 // 0 - Magpie
89 // 1 - SimplePie
9fdf7824 90
2aae0cce 91 define('SIMPLEPIE_CACHE_DIR', 'cache/simplepie');
c7d57b66
AD
92 // Cache directory for RSS feeds when using SimplePie
93
dab52d7b 94 define('SIMPLEPIE_CACHE_IMAGES', false);
bc0f0785
AD
95 // Allow caching feed images when using SimplePie, to bypass hotlink
96 // prevention and such at expense of local disk space and bandwidth.
97 // Note that you (or your users) also have to enable image caching
98 // in feed editor.
99
14073c0a
AD
100 define('COUNTERS_MAX_AGE', 365);
101 // Hard limit for unread counters calculation. Try tweaking this
102 // parameter to speed up tt-rss when having a huge number of articles
103 // in the database (better yet, enable purging!)
104
a8931123
AD
105 define('DIGEST_FROM_NAME', 'Tiny Tiny RSS');
106 define('DIGEST_FROM_ADDRESS', 'noreply@your.domain.dom');
1fb2d0d8
AD
107 // Name, address and subject for sending outgoing mail. This applies
108 // to password reset notifications, digest emails and any other mail.
109
163a295e 110 define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
1fb2d0d8 111 // Subject line for email digests
a8931123
AD
112
113 define('DIGEST_SMTP_HOST', '');
1fb2d0d8 114 // SMTP Host to send outgoing mail. Blank - use system MTA.
a8931123
AD
115
116 define('DIGEST_SMTP_LOGIN', '');
117 define('DIGEST_SMTP_PASSWORD', '');
118 // These two options enable SMTP authentication when sending
1fb2d0d8 119 // outgoing mail. Require DIGEST_SMTP_HOST.
a8931123 120
ae4ecd5d 121 define('DAEMON_FEED_LIMIT', 100);
d2bf48f9 122 // Limits the amount of feeds daemon (or a cronjob) updates on one run
ae4ecd5d 123
66917e70 124 define('ALLOW_REMOTE_USER_AUTH', false);
3d72afa1
AD
125 // Set to 'true' if you trust your web server's REMOTE_USER
126 // environment variable that the user is logged in. This option can be
127 // used to integrate tt-rss with Apache's external authentication modules.
66917e70 128
12df6592 129 define('AUTO_LOGIN', false);
bf9fc060
AD
130 // Set this to true if you use ALLOW_REMOTE_USER_AUTH or client SSL
131 // certificate authentication and you want to skip the login form.
132 // If set to true, users won't be able to set application language
133 // and settings profile.
134 // Otherwise users will be redirected to login form with their login
135 // information pre-filled.
12df6592 136
42315f8d
AD
137 define('AUTO_CREATE_USER', false);
138 // If users are authenticated by your web server, set this to true if
139 // You want new users to be automaticaly created in tt-rss database
140 // on first login
141
2aae0cce 142 define('LOCK_DIRECTORY', 'lock');
cfa43e02
AD
143 // Directory for lockfiles, must be writable to the user you run
144 // daemon process or cronjobs under.
145
04fedbf5
AD
146 define('ENABLE_GZIP_OUTPUT', false);
147 // Selectively gzip output to improve wire performance. This requires
148 // PHP Zlib extension on the server.
149
64eb624c
AD
150 define('PHP_EXECUTABLE', '/usr/bin/php');
151 // Path to PHP executable
152
4f7956b3
AD
153 define('ENABLE_REGISTRATION', false);
154 // Allow users to register themselves. Please be vary that allowing
155 // random people to access your tt-rss installation is a security risk
156 // and potentially might lead to data loss or server exploit. Disabled
157 // by default.
158
159 define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
160 // Email address to send new user notifications to.
161
162 define('REG_MAX_USERS', 10);
163 // Maximum amount of users which will be allowed to register on this
164 // system. 0 - no limit.
165
63771c48
AD
166 define('FEEDBACK_URL', '');
167 // Displays an URL for users to provide feedback or comments regarding
168 // this instance of tt-rss. Can lead to a forum, contact email, etc.
169
3907ef71
AD
170 define('FORCE_ARTICLE_PURGE', 0);
171 // When this option is not 0, users ability to control feed purging
172 // intervals is disabled and all articles (which are not starred)
173 // older than this amount of days are purged.
174
a0ce6eb7 175 define('SPHINX_ENABLED', false);
e4f7f8df
AD
176 // Enable fulltext search using Sphinx (http://www.sphinxsearch.com)
177 // Please see http://tt-rss.org/wiki/SphinxSearch for more information.
178
179 define('SPHINX_INDEX', 'ttrss');
180 // Index name in Sphinx configuration
181
96d44601
AD
182 define('ENABLE_TWEET_BUTTON', false);
183 // Enable 'tweet this' button for articles
184
392b6d04
AD
185 define('CONSUMER_KEY', '');
186 define('CONSUMER_SECRET', '');
187 // Your OAuth instance authentication information for Twitter, visit
188 // http://twitter.com/oauth_clients to register your instance.
189
b0f379df
AD
190 define('PUBSUBHUBBUB_HUB', '');
191 // URL to a PubSubHubbub-compatible hub server. If defined, Published
192 // articles generated feeds would automatically become PUSH-enabled.
193
e2bcd11b
AD
194 define('ISCONFIGURED', false);
195 // Please set this to true if you have read everything above and
196 // finished setting configuration options.
197
b0f379df 198 define('CONFIG_VERSION', 22);
f2c43604 199 // Expected config version. Please update this option in config.php
fef8a1e4
AD
200 // if necessary (after migrating all new options from this file).
201
72932a75 202 // vim:ft=php
7d4c898a 203?>