]> git.wh0rd.org Git - tt-rss.git/blob - config.php-dist
config: replace confusing option ENABLE_SIMPLEPIE with DEFAULT_UPDATE_METHOD; bump...
[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         // Unless you really know what you're doing, please keep those relative
34         // to tt-rss main directory.
35
36         define('SINGLE_USER_MODE', true);
37         // Operate in single user mode, disables all functionality related to
38         // multiple users.
39         
40         define('ENABLE_FEED_BROWSER', true);
41         // Enable or disable local feed browser
42
43         define('TMP_DIRECTORY', '/tmp');
44         // Directory for temporary files
45
46         define('FEEDS_FRAME_REFRESH', 600);
47         // Auto refresh interval for feeds frame (in seconds)
48
49         define('MAX_UPDATE_TIME', 0);
50         // Limit one update sequence run to this number of seconds.
51         // The valiue is not exact, because it is being checked between feed updates,
52         // which could use abritrary amount of time.    Feeds which could not be updated
53         // in time, are being skipped.
54         // If this option is enabled (non-zero) feeds are updated in random order.
55         // It is also recommended to set FEEDS_FRAME_REFRESH to a lower value if using
56         // this option.
57
58         define('ENABLE_UPDATE_DAEMON', false);
59         // This enables different mechanism for user-triggered updates designed
60         // for update daemon running in background on the server.
61         // This option suggests FEEDS_FRAME_REFRESH set to a small value 
62         // (like 60 seconds, depending on number of users and server/bandwidth load).
63
64         define('DAEMON_SLEEP_INTERVAL', 120);
65         // Interval between update daemon update runs
66
67         define('DATABASE_BACKED_SESSIONS', false);
68         // Store session information in a database, recommended for multiuser 
69         // configurations. Doesn't seem to work for everyone, so enable with caution.
70         // tt-rss uses default PHP session storing mechanism if disabled.
71
72         define('SESSION_CHECK_ADDRESS', true);
73         // Bind session to client IP address (recommended)
74
75         define('SESSION_COOKIE_LIFETIME', 0);
76         // Default lifetime of a session (e.g. login) cookie. In seconds, 
77         // 0 means cookie will be deleted when browser closes.
78
79         define('SESSION_EXPIRE_TIME', 86400);
80         // Hard expiration limit for sessions. Should be
81         // greater or equal to SESSION_COOKIE_LIFETIME
82
83         define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
84         // Stop updating feeds of user who was never logged in
85         // in specified amount of days. 0 disables.
86
87         define('CHECK_FOR_NEW_VERSION', true);
88         // Check for new versions of tt-rss when entering preferences.
89
90         define('USE_CURL_FOR_ICONS', false);
91         // Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
92
93         define('DIGEST_ENABLE', true);
94         // Global option to enable daily digests
95
96         define('DIGEST_EMAIL_LIMIT', 10);
97         // The maximum amount of emails sent in one digest batch
98
99         define('DAEMON_SENDS_DIGESTS', true);
100         // If update daemon and update_feeds should send digests
101         // Disable if you prefer querying special URL (see wiki)
102
103         define('ENABLE_TRANSLATIONS', true);
104         // Enable support for interface translations
105
106         define('MYSQL_CHARSET', '');
107         // Connection charset for MySQL. Only enable if having charset-related
108         // errors with MySQL (mangled characters, errors when updating feeds, etc).
109
110         define('DEFAULT_UPDATE_METHOD', 0);
111         // Which feed parsing library to use as default:
112         // 0 - Magpie
113         // 1 - SimplePie
114
115         define('SIMPLEPIE_CACHE_DIR',   '/var/tmp/simplepie-ttrss-cache');
116         // Cache directory for RSS feeds when using SimplePie
117
118         define('SIMPLEPIE_CACHE_IMAGES', false);
119         // Allow caching feed images when using SimplePie, to bypass hotlink
120         // prevention and such at expense of local disk space and bandwidth.
121         // Note that you (or your users) also have to enable image caching 
122         // in feed editor.
123         
124         define('COUNTERS_MAX_AGE', 365);
125         // Hard limit for unread counters calculation. Try tweaking this
126         // parameter to speed up tt-rss when having a huge number of articles
127         // in the database (better yet, enable purging!)
128
129         define('DIGEST_FROM_NAME', 'Tiny Tiny RSS');
130         define('DIGEST_FROM_ADDRESS', 'noreply@your.domain.dom');
131         // Name, address and subject for sending outgoing mail. This applies
132         // to password reset notifications, digest emails and any other mail.
133
134         define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
135         // Subject line for email digests
136
137         define('DIGEST_SMTP_HOST', '');
138         // SMTP Host to send outgoing mail. Blank - use system MTA.
139
140         define('DIGEST_SMTP_LOGIN', '');
141         define('DIGEST_SMTP_PASSWORD', '');
142         // These two options enable SMTP authentication when sending
143         // outgoing mail. Require DIGEST_SMTP_HOST.
144
145         define('DAEMON_FEED_LIMIT', 100);
146         // Limits the amount of feeds daemon (or a cronjob) updates on one run
147
148         define('ALLOW_REMOTE_USER_AUTH', false);
149    // Set to 'true' if you trust your web server's REMOTE_USER
150         // environment variable to validate that the user is logged in. This
151         // option can be used to integrate tt-rss with Apache's external
152         // authentication modules.
153
154         define('LOCK_DIRECTORY', '.');
155         // Directory for lockfiles, must be writable to the user you run
156         // daemon process or cronjobs under.
157
158         define('ALLOW_SELECT_UPDATE_METHOD', true);
159         // Allow users to select the library to update feeds with - e.g.
160         // Magpie or SimplePie
161
162         define('ENABLE_GZIP_OUTPUT', false);
163         // Selectively gzip output to improve wire performance. This requires
164         // PHP Zlib extension on the server.
165
166         define('PHP_EXECUTABLE', '/usr/bin/php');
167         // Path to PHP executable
168
169         define('ENABLE_REGISTRATION', false);
170         // Allow users to register themselves. Please be vary that allowing
171         // random people to access your tt-rss installation is a security risk
172         // and potentially might lead to data loss or server exploit. Disabled
173         // by default.
174
175         define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
176         // Email address to send new user notifications to.
177
178         define('REG_MAX_USERS', 10);
179         // Maximum amount of users which will be allowed to register on this
180         // system. 0 - no limit.
181
182         define('FEEDBACK_URL', '');
183         // Displays an URL for users to provide feedback or comments regarding
184         // this instance of tt-rss. Can lead to a forum, contact email, etc.
185
186         define('FORCE_ARTICLE_PURGE', 0);
187         // When this option is not 0, users ability to control feed purging
188         // intervals is disabled and all articles (which are not starred) 
189         // older than this amount of days are purged.
190
191         define('CONFIG_VERSION', 19);
192         // Expected config version. Please update this option in config.php
193         // if necessary (after migrating all new options from this file).
194
195         // vim:ft=php
196 ?>