]> git.wh0rd.org Git - tt-rss.git/blob - config.php-dist
tweak rss.xsl (2)
[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('DAEMON_REFRESH_ONLY', false);
39         // updates to all feeds will only run when the backend script is
40         // invoked with a "daemon" option on the URI stem. This is useful when you
41         // are hosting multi-user system and want to control how often 
42         // feeds are being updated.
43         
44         // An example wget command line below will invoke an update every 30 
45         // minutes, with output being sent to /dev/null and the timeout set to 
46         // 10 minutes so that wget does not time out. Substitute your site name
47         // and tt-rss path as necessary.
48         //
49         // */30 * * * * /usr/bin/wget -O /dev/null -T 600 "http://www.your-site.xxx/tt-rss/backend.php?op=globalUpdateFeeds&daemon=1"
50         //
51
52         // The alternative approach is to run update_feeds.php from your crontab
53         // with command line PHP interpreter. Don't forget to chdir() into TT-RSS
54         // directory or it won't be able to find includes. E.g.
55         //
56         // */30 * * * * cd $TTRSS_DIRECTORY && ./update_feeds.php >/dev/null 2>&1
57
58         // Another alternative approach is to run update_daemon.php in the background
59         // on the server, which allows user-scheduled updates and continous
60         // feed updating in the background. This is the recommended way at the moment.
61         
62         define('SMART_RPC_COUNTERS', false);
63         // If enabled, stores feed counter information on the server side and sends
64         // only diffs to the client. In the nutshell, it saves your bandwidth and
65         // makes UI more responsive, but eats server memory.
66         // This option can introduce a lot of weird interface glitches in
67         // some use-cases (if you have more than one tt-rss window open, for example)
68         // so it is disabled by default.
69
70         define('GLOBAL_ENABLE_LABELS', false);
71         // Labels are a security risk, so this option can globally disable them for all users.
72
73         define('MAIL_RESET_PASS', true);
74         // Send mail to user on password reset
75         
76         define('MAIL_FROM', 'TT-RSS Daemon <noreply@some.ttrss.host.dom>');
77         // Pretty obvious, I suppose. Used for email digests & password notifications.
78
79         define('ENABLE_FEED_BROWSER', true);
80         // Enable or disable local feed browser
81
82         define('TMP_DIRECTORY', '/tmp');
83         // Directory for temporary files
84
85         define('FEEDS_FRAME_REFRESH', 600);
86         // Auto refresh interval for feeds frame (in seconds)
87
88         define('MAX_UPDATE_TIME', 0);
89         // Limit one update sequence run to this number of seconds.
90         // The valiue is not exact, because it is being checked between feed updates,
91         // which could use abritrary amount of time.    Feeds which could not be updated
92         // in time, are being skipped.
93         // If this option is enabled (non-zero) feeds are updated in random order.
94         // It is also recommended to set FEEDS_FRAME_REFRESH to a lower value if using
95         // this option.
96
97         define('ENABLE_UPDATE_DAEMON', false);
98         // This enables different mechanism for user-triggered updates designed
99         // for update daemon running in background on the server.
100         // This option suggests FEEDS_FRAME_REFRESH set to a small value 
101         // (like 60 seconds, depending on number of users and server/bandwidth load).
102
103         define('DAEMON_SLEEP_INTERVAL', 120);
104         // Interval between update daemon update runs
105
106         define('DATABASE_BACKED_SESSIONS', false);
107         // Store session information in a database, recommended for multiuser 
108         // configurations. Doesn't seem to work for everyone, so enable with caution.
109         // tt-rss uses default PHP session storing mechanism if disabled.
110
111         define('SESSION_CHECK_ADDRESS', true);
112         // Bind session to client IP address (recommended)
113
114         define('SESSION_COOKIE_LIFETIME', 0);
115         // Default lifetime of a session (e.g. login) cookie. In seconds, 
116         // 0 means cookie will be deleted when browser closes.
117
118         define('SESSION_EXPIRE_TIME', 86400);
119         // Hard expiration limit for sessions. Should be
120         // greater or equal to SESSION_COOKIE_LIFETIME
121
122         define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
123         // Stop updating feeds of user who was never logged in
124         // in specified amount of days. 0 disables.
125
126         define('CHECK_FOR_NEW_VERSION', true);
127         // Check for new versions of tt-rss when entering preferences.
128
129         define('USE_CURL_FOR_ICONS', false);
130         // Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
131
132         define('DIGEST_ENABLE', true);
133         // Global option to enable daily digests
134
135         define('DIGEST_HOSTNAME', 'some.ttrss.host.dom');
136         // Hostname for email digest signature
137
138         define('DIGEST_EMAIL_LIMIT', 10);
139         // The maximum amount of emails sent in one digest batch
140
141         define('DAEMON_SENDS_DIGESTS', true);
142         // If update daemon and update_feeds should send digests
143         // Disable if you prefer querying special URL (see wiki)
144
145         define('ENABLE_TRANSLATIONS', false);
146         // Enable experimental support for interface translations
147         // based on PHP-Gettext. This is of no much use right now.
148
149         define('MYSQL_CHARSET', '');
150         // Connection charset for MySQL. Only enable if having charset-related
151         // errors with MySQL (mangled characters, errors when updating feeds, etc).
152
153         define('ENABLE_SIMPLEPIE', false);
154         // Enables SimplePie RSS parsing library (experimental). When this option 
155         // is disabled, Tiny Tiny RSS defaults to Magpie library. 
156
157         // SimplePie is somewhat faster, more robust and less clunky as Magpie. 
158         // While it doesn't internally support HTTP Digest authentication 
159         // (required for Livejournal protected feeds and such) and SSL, it can
160         // support it when using CURL.
161
162         // To summarize, if your PHP has CURL extension or you aren't subscribed
163         // to any feeds using HTTP Digest authentication and Magpie XML parsing 
164         // errors are bothering you too much, you can try enabling SimplePie.
165
166         define('SIMPLEPIE_CACHE_DIR',   '/var/tmp/simplepie-ttrss-cache');
167         // Cache directory for RSS feeds when using SimplePie
168
169         define('SIMPLEPIE_CACHE_IMAGES', false);
170         // Allow caching feed images when using SimplePie, to bypass hotlink
171         // prevention and such at expense of local disk space and bandwidth.
172         // Note that you (or your users) also have to enable image caching 
173         // in feed editor.
174         
175         define('COUNTERS_MAX_AGE', 365);
176         // Hard limit for unread counters calculation. Try tweaking this
177         // parameter to speed up tt-rss when having a huge number of articles
178         // in the database (better yet, enable purging!)
179
180         define('CONFIG_VERSION', 9);
181         // Expected config version. Please update this option in config.php
182         // if necessary (after migrating all new options from this file).
183
184         // vim:ft=php
185 ?>