]> git.wh0rd.org Git - tt-rss.git/blob - config.php-dist
add mail and share plugins
[tt-rss.git] / config.php-dist
1 <?php
2         // *******************************************
3         // *** Database configuration (important!) ***
4         // *******************************************
5
6         define('DB_TYPE', "pgsql"); // or mysql
7         define('DB_HOST', "localhost");
8         define('DB_USER', "fox");
9         define('DB_NAME', "fox");
10         define('DB_PASS', "XXXXXX");
11         //define('DB_PORT', '5432'); // when neeeded, PG-only
12
13         define('MYSQL_CHARSET', 'UTF8');
14         // Connection charset for MySQL. If you have a legacy database and/or experience
15         // garbage unicode characters with this option, try setting it to a blank string.
16
17         // ***********************************
18         // *** Basic settings (important!) ***
19         // ***********************************
20
21         define('SELF_URL_PATH', 'http://yourserver/tt-rss/');
22         // Full URL of your tt-rss installation. This should be set to the
23         // location of tt-rss directory, e.g. http://yourserver/tt-rss/
24         // You need to set this option correctly otherwise several features
25         // including PUSH, bookmarklets and browser integration will not work properly.
26
27         define('SINGLE_USER_MODE', false);
28         // Operate in single user mode, disables all functionality related to
29         // multiple users.
30
31         // *****************************
32         // *** Files and directories ***
33         // *****************************
34
35         define('PHP_EXECUTABLE', '/usr/bin/php');
36         // Path to PHP executable, used for various command-line tt-rss programs
37
38         define('LOCK_DIRECTORY', 'lock');
39         // Directory for lockfiles, must be writable to the user you run
40         // daemon process or cronjobs under.
41
42         define('CACHE_DIR', 'cache');
43         // Local cache directory for RSS feed content.
44
45         define('TMP_DIRECTORY', '/tmp');
46         // Directory for temporary files
47
48         define('ICONS_DIR', "feed-icons");
49         define('ICONS_URL', "feed-icons");
50         // Local and URL path to the directory, where feed favicons are stored.
51         // Unless you really know what you're doing, please keep those relative
52         // to tt-rss main directory.
53
54         // *********************
55         // *** Feed settings ***
56         // *********************
57
58         define('SIMPLEPIE_CACHE_IMAGES', false);
59         // Allow caching feed images when using SimplePie, to bypass hotlink
60         // prevention and such at expense of local disk space and bandwidth.
61         // Note that you (or your users) also have to enable image caching 
62         // in feed editor.
63
64         define('DEFAULT_UPDATE_METHOD', 0);
65         // Which feed parsing library to use as default:
66         // 0 - Magpie
67         // 1 - SimplePie
68
69         define('FORCE_ARTICLE_PURGE', 0);
70         // When this option is not 0, users ability to control feed purging
71         // intervals is disabled and all articles (which are not starred) 
72         // older than this amount of days are purged.
73
74         // *** PubSubHubbub settings ***
75
76         define('PUBSUBHUBBUB_HUB', '');
77         // URL to a PubSubHubbub-compatible hub server. If defined, "Published
78         // articles" generated feed would automatically become PUSH-enabled.
79
80         define('PUBSUBHUBBUB_ENABLED', true);
81         // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
82         // won't try to subscribe to PUSH feed updates.
83
84         // *********************
85         // *** Sphinx search ***
86         // *********************
87
88         define('SPHINX_ENABLED', false);
89         // Enable fulltext search using Sphinx (http://www.sphinxsearch.com)
90         // Please see http://tt-rss.org/wiki/SphinxSearch for more information.
91
92         define('SPHINX_INDEX', 'ttrss');
93         // Index name in Sphinx configuration. You can specify multiple indexes
94         // as a comma-separated string.
95
96         // **********************
97         // *** Authentication ***
98         // **********************
99
100         define('ALLOW_REMOTE_USER_AUTH', false);
101         // Set to 'true' if you trust your web server's REMOTE_USER 
102         // environment variable that the user is logged in. This option can be 
103         // used to integrate tt-rss with Apache's external authentication modules.
104
105         define('AUTO_LOGIN', false);
106         // Set this to true if you use ALLOW_REMOTE_USER_AUTH or client SSL
107         // certificate authentication and you want to skip the login form. 
108         // If set to true, users won't be able to set application language 
109         // and settings profile.
110         // Otherwise users will be redirected to login form with their login
111         // information pre-filled.
112
113         define('AUTO_CREATE_USER', false);
114         // If users are authenticated by your web server, set this to true if
115         // You want new users to be automaticaly created in tt-rss database
116         // on first login
117
118         // ***********************************
119         // *** Self-registrations by users ***
120         // ***********************************
121
122         define('ENABLE_REGISTRATION', false);
123         // Allow users to register themselves. Please be vary that allowing
124         // random people to access your tt-rss installation is a security risk
125         // and potentially might lead to data loss or server exploit. Disabled
126         // by default.
127
128         define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
129         // Email address to send new user notifications to.
130
131         define('REG_MAX_USERS', 10);
132         // Maximum amount of users which will be allowed to register on this
133         // system. 0 - no limit.
134
135         // **********************************
136         // *** Cookies and login sessions ***
137         // **********************************
138         
139         define('SESSION_COOKIE_LIFETIME', 0);
140         // Default lifetime of a session (e.g. login) cookie. In seconds, 
141         // 0 means cookie will be deleted when browser closes.
142
143         define('SESSION_EXPIRE_TIME', 86400);
144         // Hard expiration limit for sessions. Should be
145         // greater or equal to SESSION_COOKIE_LIFETIME
146
147         define('SESSION_CHECK_ADDRESS', 1);
148         // Check client IP address when validating session:
149         // 0 - disable checking
150         // 1 - check first 3 octets of an address (recommended)
151         // 2 - check first 2 octets of an address
152         // 3 - check entire address
153
154         // *********************************
155         // *** Email and digest settings ***
156         // *********************************
157
158         define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
159         define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
160         // Name, address and subject for sending outgoing mail. This applies
161         // to password reset notifications, digest emails and any other mail.
162
163         define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
164         // Subject line for email digests
165
166         define('SMTP_HOST', '');
167         // SMTP Host to send outgoing mail. Blank - use system MTA.
168
169         define('SMTP_LOGIN', '');
170         define('SMTP_PASSWORD', '');
171         // These two options enable SMTP authentication when sending
172         // outgoing mail. Only used with SMTP_HOST
173
174         // ************************************
175         // *** Twitter integration settings ***
176         // ************************************
177         
178         define('CONSUMER_KEY', '');
179         define('CONSUMER_SECRET', '');
180         // Your OAuth instance authentication information for Twitter, visit
181         // http://twitter.com/oauth_clients to register your instance.
182
183         // ***************************************
184         // *** Other settings (less important) ***
185         // ***************************************
186
187         define('CHECK_FOR_NEW_VERSION', true);
188         // Check for new versions of tt-rss automatically.
189
190         define('COUNTERS_MAX_AGE', 365);
191         // Hard limit for unread counters calculation. Try tweaking this
192         // parameter to speed up tt-rss when having a huge number of articles
193         // in the database (better yet, enable purging!)
194
195         define('ENABLE_GZIP_OUTPUT', false);
196         // Selectively gzip output to improve wire performance. This requires
197         // PHP Zlib extension on the server.
198
199         define('FEEDBACK_URL', '');
200         // Displays an URL for users to provide feedback or comments regarding
201         // this instance of tt-rss. Can lead to a forum, contact email, etc.
202
203         define('ARTICLE_BUTTON_PLUGINS', 'tweet,share,mail');
204         // Comma-separated list of additional article action button plugins
205         // to enable, like tweet button, etc.
206         // The following plugins are available: tweet, share, mail
207
208         define('CONFIG_VERSION', 24);
209         // Expected config version. Please update this option in config.php
210         // if necessary (after migrating all new options from this file).
211
212         // vim:ft=php
213 ?>