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