]> git.wh0rd.org Git - tt-rss.git/blob - config.php-dist
update.php: fix help text
[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('ICONS_DIR', "feed-icons");
46         define('ICONS_URL', "feed-icons");
47         // Local and URL path to the directory, where feed favicons are stored.
48         // Unless you really know what you're doing, please keep those relative
49         // to tt-rss main directory.
50
51         // *********************
52         // *** Feed settings ***
53         // *********************
54
55         define('DEFAULT_UPDATE_METHOD', 0);
56         // Which feed parsing library to use as default:
57         // 0 - Magpie
58         // 1 - SimplePie
59
60         define('FORCE_ARTICLE_PURGE', 0);
61         // When this option is not 0, users ability to control feed purging
62         // intervals is disabled and all articles (which are not starred) 
63         // older than this amount of days are purged.
64
65         // *** PubSubHubbub settings ***
66
67         define('PUBSUBHUBBUB_HUB', '');
68         // URL to a PubSubHubbub-compatible hub server. If defined, "Published
69         // articles" generated feed would automatically become PUSH-enabled.
70
71         define('PUBSUBHUBBUB_ENABLED', false);
72         // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
73         // won't try to subscribe to PUSH feed updates.
74
75         // *********************
76         // *** Sphinx search ***
77         // *********************
78
79         define('SPHINX_ENABLED', false);
80         // Enable fulltext search using Sphinx (http://www.sphinxsearch.com)
81         // Please see http://tt-rss.org/wiki/SphinxSearch for more information.
82
83         define('SPHINX_INDEX', 'ttrss');
84         // Index name in Sphinx configuration. You can specify multiple indexes
85         // as a comma-separated string.
86
87         // **********************
88         // *** Authentication ***
89         // **********************
90
91         define('ALLOW_REMOTE_USER_AUTH', false);
92         // Set to 'true' if you trust your web server's REMOTE_USER 
93         // environment variable that the user is logged in. This option can be 
94         // used to integrate tt-rss with Apache's external authentication modules.
95
96         define('AUTO_LOGIN', false);
97         // Set this to true if you use ALLOW_REMOTE_USER_AUTH or client SSL
98         // certificate authentication and you want to skip the login form. 
99         // If set to true, users won't be able to set application language 
100         // and settings profile.
101         // Otherwise users will be redirected to login form with their login
102         // information pre-filled.
103
104         define('AUTO_CREATE_USER', false);
105         // If users are authenticated by your web server, set this to true if
106         // You want new users to be automaticaly created in tt-rss database
107         // on first login
108
109         // ***********************************
110         // *** Self-registrations by users ***
111         // ***********************************
112
113         define('ENABLE_REGISTRATION', false);
114         // Allow users to register themselves. Please be vary that allowing
115         // random people to access your tt-rss installation is a security risk
116         // and potentially might lead to data loss or server exploit. Disabled
117         // by default.
118
119         define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
120         // Email address to send new user notifications to.
121
122         define('REG_MAX_USERS', 10);
123         // Maximum amount of users which will be allowed to register on this
124         // system. 0 - no limit.
125
126         // **********************************
127         // *** Cookies and login sessions ***
128         // **********************************
129         
130         define('SESSION_COOKIE_LIFETIME', 0);
131         // Default lifetime of a session (e.g. login) cookie. In seconds, 
132         // 0 means cookie will be deleted when browser closes.
133
134         define('SESSION_EXPIRE_TIME', 86400);
135         // Hard expiration limit for sessions. Should be
136         // greater or equal to SESSION_COOKIE_LIFETIME
137
138         define('SESSION_CHECK_ADDRESS', 1);
139         // Check client IP address when validating session:
140         // 0 - disable checking
141         // 1 - check first 3 octets of an address (recommended)
142         // 2 - check first 2 octets of an address
143         // 3 - check entire address
144
145         // *********************************
146         // *** Email and digest settings ***
147         // *********************************
148
149         define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
150         define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
151         // Name, address and subject for sending outgoing mail. This applies
152         // to password reset notifications, digest emails and any other mail.
153
154         define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
155         // Subject line for email digests
156
157         define('SMTP_HOST', '');
158         // SMTP Host to send outgoing mail. Blank - use system MTA.
159
160         define('SMTP_LOGIN', '');
161         define('SMTP_PASSWORD', '');
162         // These two options enable SMTP authentication when sending
163         // outgoing mail. Only used with SMTP_HOST
164
165         // ************************************
166         // *** Twitter integration settings ***
167         // ************************************
168         
169         define('CONSUMER_KEY', '');
170         define('CONSUMER_SECRET', '');
171         // Your OAuth instance authentication information for Twitter, visit
172         // http://twitter.com/oauth_clients to register your instance.
173
174         // ***************************************
175         // *** Other settings (less important) ***
176         // ***************************************
177
178         define('CHECK_FOR_NEW_VERSION', true);
179         // Check for new versions of tt-rss automatically.
180
181         define('ENABLE_GZIP_OUTPUT', false);
182         // Selectively gzip output to improve wire performance. This requires
183         // PHP Zlib extension on the server.
184         // Enabling this can break tt-rss in several httpd/php configurations,
185         // if you experience weird errors and tt-rss failing to start, blank pages
186         // after login, or content encoding errors, disable it.
187
188         define('FEEDBACK_URL', '');
189         // Displays an URL for users to provide feedback or comments regarding
190         // this instance of tt-rss. Can lead to a forum, contact email, etc.
191
192         define('ARTICLE_BUTTON_PLUGINS', 'note,tweet,share,mail');
193         // Comma-separated list of additional article action button plugins
194         // to enable, like tweet button, etc.
195         // The following plugins are available: note, tweet, share, mail
196         // More plugins: http://tt-rss.org/wiki/Plugins
197
198         define('CONFIG_VERSION', 25);
199         // Expected config version. Please update this option in config.php
200         // if necessary (after migrating all new options from this file).
201
202         // vim:ft=php
203 ?>