]> git.wh0rd.org Git - tt-rss.git/blob - config.php-dist
feed browser: fix escaping
[tt-rss.git] / config.php-dist
1 <?php
2         // Your RDBMS must be configured to accept connections
3         // via TCP/IP and authentified by password.
4
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");
10         //define('DB_PORT', '5432'); // when neeeded, PG-only
11
12         define('MAGPIE_FETCH_TIME_OUT', 60);
13         // Magpie's default timeout is 5 seconds.  Some RSS feeds,
14         // such as from large Trac installs, can take significantly
15         // longer than 5 seconds to generate.  To prevent failed
16         // updates, increase this.
17
18         define('MAGPIE_CACHE_DIR', '/var/tmp/magpie-ttrss-cache');
19         // Local cache directory for RSS feeds
20
21         define('MAGPIE_CACHE_AGE', 60*30); 
22         // How long to store cached RSS objects? In seconds.
23         // Defaults to 30 minutes
24
25         define('WEB_DEMO_MODE', false);
26         // Demo mode with reduced functionality.
27         // Warning: this option is obsolete. Don't rely on it being
28         // checked in all necessary places.
29
30         define('ICONS_DIR', "icons");
31         define('ICONS_URL', "icons");
32         // Local and URL path to the directory, where feed favicons are stored.
33
34         define('SINGLE_USER_MODE', true);
35         // Operate in single user mode, disables all functionality related to
36         // multiple users.
37         
38         define('SMART_RPC_COUNTERS', false);
39         // If enabled, stores feed counter information on the server side and sends
40         // only diffs to the client. In the nutshell, it saves your bandwidth and
41         // makes UI more responsive, but eats server memory.
42         // This option can introduce a lot of weird interface glitches in
43         // some use-cases (if you have more than one tt-rss window open, for example)
44         // so it is disabled by default.
45
46         define('MAIL_RESET_PASS', true);
47         // Send mail to user on password reset
48         
49         define('ENABLE_FEED_BROWSER', true);
50         // Enable or disable local feed browser
51
52         define('TMP_DIRECTORY', '/tmp');
53         // Directory for temporary files
54
55         define('FEEDS_FRAME_REFRESH', 600);
56         // Auto refresh interval for feeds frame (in seconds)
57
58         define('MAX_UPDATE_TIME', 0);
59         // Limit one update sequence run to this number of seconds.
60         // The valiue is not exact, because it is being checked between feed updates,
61         // which could use abritrary amount of time.    Feeds which could not be updated
62         // in time, are being skipped.
63         // If this option is enabled (non-zero) feeds are updated in random order.
64         // It is also recommended to set FEEDS_FRAME_REFRESH to a lower value if using
65         // this option.
66
67         define('ENABLE_UPDATE_DAEMON', false);
68         // This enables different mechanism for user-triggered updates designed
69         // for update daemon running in background on the server.
70         // This option suggests FEEDS_FRAME_REFRESH set to a small value 
71         // (like 60 seconds, depending on number of users and server/bandwidth load).
72
73         define('DAEMON_SLEEP_INTERVAL', 120);
74         // Interval between update daemon update runs
75
76         define('DATABASE_BACKED_SESSIONS', false);
77         // Store session information in a database, recommended for multiuser 
78         // configurations. Doesn't seem to work for everyone, so enable with caution.
79         // tt-rss uses default PHP session storing mechanism if disabled.
80
81         define('SESSION_CHECK_ADDRESS', true);
82         // Bind session to client IP address (recommended)
83
84         define('SESSION_COOKIE_LIFETIME', 0);
85         // Default lifetime of a session (e.g. login) cookie. In seconds, 
86         // 0 means cookie will be deleted when browser closes.
87
88         define('SESSION_EXPIRE_TIME', 86400);
89         // Hard expiration limit for sessions. Should be
90         // greater or equal to SESSION_COOKIE_LIFETIME
91
92         define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
93         // Stop updating feeds of user who was never logged in
94         // in specified amount of days. 0 disables.
95
96         define('CHECK_FOR_NEW_VERSION', true);
97         // Check for new versions of tt-rss when entering preferences.
98
99         define('USE_CURL_FOR_ICONS', false);
100         // Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
101
102         define('DIGEST_ENABLE', true);
103         // Global option to enable daily digests
104
105         define('DIGEST_EMAIL_LIMIT', 10);
106         // The maximum amount of emails sent in one digest batch
107
108         define('DAEMON_SENDS_DIGESTS', true);
109         // If update daemon and update_feeds should send digests
110         // Disable if you prefer querying special URL (see wiki)
111
112         define('ENABLE_TRANSLATIONS', false);
113         // Enable experimental support for interface translations
114         // based on PHP-Gettext. This is of no much use right now.
115
116         define('MYSQL_CHARSET', '');
117         // Connection charset for MySQL. Only enable if having charset-related
118         // errors with MySQL (mangled characters, errors when updating feeds, etc).
119
120         define('ENABLE_SIMPLEPIE', false);
121         // Enables SimplePie RSS parsing library (experimental). When this option 
122         // is disabled, Tiny Tiny RSS defaults to Magpie library. 
123
124         // SimplePie is somewhat faster, more robust and less clunky as Magpie. 
125         // While it doesn't internally support HTTP Digest authentication 
126         // (required for Livejournal protected feeds and such) and SSL, it can
127         // support it when using CURL.
128
129         // To summarize, if your PHP has CURL extension or you aren't subscribed
130         // to any feeds using HTTP Digest authentication and Magpie XML parsing 
131         // errors are bothering you too much, you can try enabling SimplePie.
132
133         define('SIMPLEPIE_CACHE_DIR',   '/var/tmp/simplepie-ttrss-cache');
134         // Cache directory for RSS feeds when using SimplePie
135
136         define('SIMPLEPIE_CACHE_IMAGES', false);
137         // Allow caching feed images when using SimplePie, to bypass hotlink
138         // prevention and such at expense of local disk space and bandwidth.
139         // Note that you (or your users) also have to enable image caching 
140         // in feed editor.
141         
142         define('COUNTERS_MAX_AGE', 365);
143         // Hard limit for unread counters calculation. Try tweaking this
144         // parameter to speed up tt-rss when having a huge number of articles
145         // in the database (better yet, enable purging!)
146
147         define('DIGEST_FROM_NAME', 'Tiny Tiny RSS');
148         define('DIGEST_FROM_ADDRESS', 'noreply@your.domain.dom');
149         // Name, address and subject for sending outgoing mail. This applies
150         // to password reset notifications, digest emails and any other mail.
151
152         define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
153         // Subject line for email digests
154
155         define('DIGEST_SMTP_HOST', '');
156         // SMTP Host to send outgoing mail. Blank - use system MTA.
157
158         define('DIGEST_SMTP_LOGIN', '');
159         define('DIGEST_SMTP_PASSWORD', '');
160         // These two options enable SMTP authentication when sending
161         // outgoing mail. Require DIGEST_SMTP_HOST.
162
163         define('DAEMON_FEED_LIMIT', 100);
164         // Limits the amount of feeds daemon (or a cronjob) updates on one run
165
166         define('ALLOW_REMOTE_USER_AUTH', false);
167    // Set to 'true' if you trust your web server's REMOTE_USER
168         // environment variable to validate that the user is logged in. This
169         // option can be used to integrate tt-rss with Apache's external
170         // authentication modules.
171
172         define('LOCK_DIRECTORY', '.');
173         // Directory for lockfiles, must be writable to the user you run
174         // daemon process or cronjobs under.
175
176         define('ALLOW_SELECT_UPDATE_METHOD', true);
177         // Allow users to select the library to update feeds with - e.g.
178         // Magpie or SimplePie
179
180         define('ENABLE_GZIP_OUTPUT', false);
181         // Selectively gzip output to improve wire performance. This requires
182         // PHP Zlib extension on the server.
183
184         define('PHP_EXECUTABLE', '/usr/bin/php');
185         // Path to PHP executable
186
187         define('ENABLE_REGISTRATION', false);
188         // Allow users to register themselves. Please be vary that allowing
189         // random people to access your tt-rss installation is a security risk
190         // and potentially might lead to data loss or server exploit. Disabled
191         // by default.
192
193         define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
194         // Email address to send new user notifications to.
195
196         define('REG_MAX_USERS', 10);
197         // Maximum amount of users which will be allowed to register on this
198         // system. 0 - no limit.
199
200         define('FEEDBACK_URL', '');
201         // Displays an URL for users to provide feedback or comments regarding
202         // this instance of tt-rss. Can lead to a forum, contact email, etc.
203
204         define('FORCE_ARTICLE_PURGE', 0);
205         // When this option is not 0, users ability to control feed purging
206         // intervals is disabled and all articles (which are not starred) 
207         // older than this amount of days are purged.
208
209         define('CONFIG_VERSION', 18);
210         // Expected config version. Please update this option in config.php
211         // if necessary (after migrating all new options from this file).
212
213         // vim:ft=php
214 ?>