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