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