]> git.wh0rd.org - tt-rss.git/blob - config.php-dist
Merge branch 'master' of git://github.com/justauserx/Tiny-Tiny-RSS into justauserx...
[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', ''); // usually 5432 for PostgreSQL, 3306 for MySQL
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('FEED_CRYPT_KEY', '');
28 // Key used for encryption of passwords for password-protected feeds
29 // in the database. A string of 24 random characters. If left blank, encryption
30 // is not used. Requires mcrypt functions.
31 // Warning: changing this key will make your stored feed passwords impossible
32 // to decrypt.
33
34 define('SINGLE_USER_MODE', false);
35 // Operate in single user mode, disables all functionality related to
36 // multiple users and authentication. Enabling this assumes you have
37 // your tt-rss directory protected by other means (e.g. http auth).
38
39 define('SIMPLE_UPDATE_MODE', false);
40 // Enables fallback update mode where tt-rss tries to update feeds in
41 // background while tt-rss is open in your browser.
42 // If you don't have a lot of feeds and don't want to or can't run
43 // background processes while not running tt-rss, this method is generally
44 // viable to keep your feeds up to date.
45 // Still, there are more robust (and recommended) updating methods
46 // available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
47
48 // *****************************
49 // *** Files and directories ***
50 // *****************************
51
52 define('PHP_EXECUTABLE', '/usr/bin/php');
53 // Path to PHP *COMMAND LINE* executable, used for various command-line tt-rss programs and
54 // update daemon. Do not try to use CGI binary here, it won't work. If you see HTTP headers
55 // being displayed while running tt-rss scripts, then most probably you are using the CGI
56 // binary. If you are unsure what to put in here, ask your hosting provider.
57
58 define('LOCK_DIRECTORY', 'lock');
59 // Directory for lockfiles, must be writable to the user you run
60 // daemon process or cronjobs under.
61
62 define('CACHE_DIR', 'cache');
63 // Local cache directory for RSS feed content.
64
65 define('ICONS_DIR', "feed-icons");
66 define('ICONS_URL', "feed-icons");
67 // Local and URL path to the directory, where feed favicons are stored.
68 // Unless you really know what you're doing, please keep those relative
69 // to tt-rss main directory.
70
71 // **********************
72 // *** Authentication ***
73 // **********************
74
75 // Please see PLUGINS below to configure various authentication modules.
76
77 define('AUTH_AUTO_CREATE', true);
78 // Allow authentication modules to auto-create users in tt-rss internal
79 // database when authenticated successfully.
80
81 define('AUTH_AUTO_LOGIN', true);
82 // Automatically login user on remote or other kind of externally supplied
83 // authentication, otherwise redirect to login form as normal.
84 // If set to true, users won't be able to set application language
85 // and settings profile.
86
87 // *********************
88 // *** Feed settings ***
89 // *********************
90
91 define('FORCE_ARTICLE_PURGE', 0);
92 // When this option is not 0, users ability to control feed purging
93 // intervals is disabled and all articles (which are not starred)
94 // older than this amount of days are purged.
95
96 // *** PubSubHubbub settings ***
97
98 define('PUBSUBHUBBUB_HUB', '');
99 // URL to a PubSubHubbub-compatible hub server. If defined, "Published
100 // articles" generated feed would automatically become PUSH-enabled.
101
102 define('PUBSUBHUBBUB_ENABLED', false);
103 // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
104 // won't try to subscribe to PUSH feed updates.
105
106 // *********************
107 // *** Sphinx search ***
108 // *********************
109
110 define('SPHINX_ENABLED', false);
111 // Enable fulltext search using Sphinx (http://www.sphinxsearch.com)
112 // Please see http://tt-rss.org/wiki/SphinxSearch for more information.
113
114 define('SPHINX_SERVER', 'localhost:9312');
115 // Hostname:port combination for the Sphinx server.
116
117 define('SPHINX_INDEX', 'ttrss, delta');
118 // Index name in Sphinx configuration. You can specify multiple indexes
119 // as a comma-separated string.
120 // Example configuration files are available on tt-rss wiki.
121
122 // ***********************************
123 // *** Self-registrations by users ***
124 // ***********************************
125
126 define('ENABLE_REGISTRATION', false);
127 // Allow users to register themselves. Please be aware that allowing
128 // random people to access your tt-rss installation is a security risk
129 // and potentially might lead to data loss or server exploit. Disabled
130 // by default.
131
132 define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
133 // Email address to send new user notifications to.
134
135 define('REG_MAX_USERS', 10);
136 // Maximum amount of users which will be allowed to register on this
137 // system. 0 - no limit.
138
139 // **********************************
140 // *** Cookies and login sessions ***
141 // **********************************
142
143 define('SESSION_COOKIE_LIFETIME', 86400);
144 // Default lifetime of a session (e.g. login) cookie. In seconds,
145 // 0 means cookie will be deleted when browser closes.
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_SERVER', '');
167 // Hostname:port combination to send outgoing mail (i.e. localhost:25).
168 // Blank - use system MTA.
169
170 define('SMTP_LOGIN', '');
171 define('SMTP_PASSWORD', '');
172 // These two options enable SMTP authentication when sending
173 // outgoing mail. Only used with SMTP_SERVER.
174
175 define('SMTP_SECURE', '');
176 // used to select a secure SMTP conneciton. can be tls, ssl or enpty
177
178 // ***************************************
179 // *** Other settings (less important) ***
180 // ***************************************
181
182 define('CHECK_FOR_NEW_VERSION', true);
183 // Check for new versions of tt-rss automatically.
184
185 define('ENABLE_GZIP_OUTPUT', false);
186 // Selectively gzip output to improve wire performance. This requires
187 // PHP Zlib extension on the server.
188 // Enabling this can break tt-rss in several httpd/php configurations,
189 // if you experience weird errors and tt-rss failing to start, blank pages
190 // after login, or content encoding errors, disable it.
191
192 define('PLUGINS', 'auth_internal, note, updater');
193 // Comma-separated list of plugins to load automatically for all users.
194 // System plugins have to be specified here. Please enable at least one
195 // authentication plugin here (auth_*).
196 // Users may enable other user plugins from Preferences/Plugins but may not
197 // disable plugins specified in this list.
198 // Disabling auth_internal in this list would automatically disable
199 // reset password link on the login form.
200
201 define('LOG_DESTINATION', 'sql');
202 // Log destination to use. Possible values: sql (uses internal logging
203 // you can read in Preferences -> System), syslog - logs to system log.
204 // Setting this to blank uses PHP logging (usually to http server
205 // error.log).
206
207 define('CONFIG_VERSION', 26);
208 // Expected config version. Please update this option in config.php
209 // if necessary (after migrating all new options from this file).
210
211 // vim:ft=php
212 ?>