]> git.wh0rd.org - tt-rss.git/blob - config.php-dist
clarify single user mode description
[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 and authentication. Enabling this assumes you have
30 // your tt-rss directory protected by other means (e.g. http auth).
31
32 define('SIMPLE_UPDATE_MODE', false);
33 // Enables fallback update mode where tt-rss tries to update feeds in
34 // background while tt-rss is open in your browser.
35 // If you don't have a lot of feeds and don't want to or can't run
36 // background processes while not running tt-rss, this method is generally
37 // viable to keep your feeds up to date.
38 // Still, there are more robust (and recommended) updating methods
39 // available, you can read about them here: http://tt-rss.org/wiki/UpdatingFeeds
40
41 // *****************************
42 // *** Files and directories ***
43 // *****************************
44
45 define('PHP_EXECUTABLE', '/usr/bin/php');
46 // Path to PHP executable, used for various command-line tt-rss programs
47
48 define('LOCK_DIRECTORY', 'lock');
49 // Directory for lockfiles, must be writable to the user you run
50 // daemon process or cronjobs under.
51
52 define('CACHE_DIR', 'cache');
53 // Local cache directory for RSS feed content.
54
55 define('ICONS_DIR', "feed-icons");
56 define('ICONS_URL', "feed-icons");
57 // Local and URL path to the directory, where feed favicons are stored.
58 // Unless you really know what you're doing, please keep those relative
59 // to tt-rss main directory.
60
61 // **********************
62 // *** Authentication ***
63 // **********************
64
65 // Please see PLUGINS below to configure various authentication modules.
66
67 define('AUTH_AUTO_CREATE', true);
68 // Allow authentication modules to auto-create users in tt-rss internal
69 // database when authenticated successfully.
70
71 define('AUTH_AUTO_LOGIN', true);
72 // Automatically login user on remote or other kind of externally supplied
73 // authentication, otherwise redirect to login form as normal.
74 // If set to true, users won't be able to set application language
75 // and settings profile.
76
77 // *********************
78 // *** Feed settings ***
79 // *********************
80
81 define('FORCE_ARTICLE_PURGE', 0);
82 // When this option is not 0, users ability to control feed purging
83 // intervals is disabled and all articles (which are not starred)
84 // older than this amount of days are purged.
85
86 // *** PubSubHubbub settings ***
87
88 define('PUBSUBHUBBUB_HUB', '');
89 // URL to a PubSubHubbub-compatible hub server. If defined, "Published
90 // articles" generated feed would automatically become PUSH-enabled.
91
92 define('PUBSUBHUBBUB_ENABLED', false);
93 // Enable client PubSubHubbub support in tt-rss. When disabled, tt-rss
94 // won't try to subscribe to PUSH feed updates.
95
96 // *********************
97 // *** Sphinx search ***
98 // *********************
99
100 define('SPHINX_ENABLED', false);
101 // Enable fulltext search using Sphinx (http://www.sphinxsearch.com)
102 // Please see http://tt-rss.org/wiki/SphinxSearch for more information.
103
104 define('SPHINX_INDEX', 'ttrss');
105 // Index name in Sphinx configuration. You can specify multiple indexes
106 // as a comma-separated string.
107
108 // ***********************************
109 // *** Self-registrations by users ***
110 // ***********************************
111
112 define('ENABLE_REGISTRATION', false);
113 // Allow users to register themselves. Please be aware that allowing
114 // random people to access your tt-rss installation is a security risk
115 // and potentially might lead to data loss or server exploit. Disabled
116 // by default.
117
118 define('REG_NOTIFY_ADDRESS', 'user@your.domain.dom');
119 // Email address to send new user notifications to.
120
121 define('REG_MAX_USERS', 10);
122 // Maximum amount of users which will be allowed to register on this
123 // system. 0 - no limit.
124
125 // **********************************
126 // *** Cookies and login sessions ***
127 // **********************************
128
129 define('SESSION_COOKIE_LIFETIME', 86400);
130 // Default lifetime of a session (e.g. login) cookie. In seconds,
131 // 0 means cookie will be deleted when browser closes.
132 // Setting this to zero will affect several user preferences
133 // like widescreen mode not saving and disable "remember me".
134 // Note that if remember me is not checked, session cookie
135 // will always expire with browser session.
136
137 define('SESSION_CHECK_ADDRESS', 1);
138 // Check client IP address when validating session:
139 // 0 - disable checking
140 // 1 - check first 3 octets of an address (recommended)
141 // 2 - check first 2 octets of an address
142 // 3 - check entire address
143
144 // *********************************
145 // *** Email and digest settings ***
146 // *********************************
147
148 define('SMTP_FROM_NAME', 'Tiny Tiny RSS');
149 define('SMTP_FROM_ADDRESS', 'noreply@your.domain.dom');
150 // Name, address and subject for sending outgoing mail. This applies
151 // to password reset notifications, digest emails and any other mail.
152
153 define('DIGEST_SUBJECT', '[tt-rss] New headlines for last 24 hours');
154 // Subject line for email digests
155
156 define('SMTP_HOST', '');
157 // SMTP Host to send outgoing mail. Blank - use system MTA.
158
159 define('SMTP_PORT','');
160 // SMTP port to sent outgoing mail. Default is 25.
161
162 define('SMTP_LOGIN', '');
163 define('SMTP_PASSWORD', '');
164 // These two options enable SMTP authentication when sending
165 // outgoing mail. Only used with SMTP_HOST
166
167 // ***************************************
168 // *** Other settings (less important) ***
169 // ***************************************
170
171 define('CHECK_FOR_NEW_VERSION', true);
172 // Check for new versions of tt-rss automatically.
173
174 define('ENABLE_GZIP_OUTPUT', false);
175 // Selectively gzip output to improve wire performance. This requires
176 // PHP Zlib extension on the server.
177 // Enabling this can break tt-rss in several httpd/php configurations,
178 // if you experience weird errors and tt-rss failing to start, blank pages
179 // after login, or content encoding errors, disable it.
180
181 define('PLUGINS', 'auth_internal, note, updater');
182 // Comma-separated list of plugins to load automatically for all users.
183 // System plugins have to be specified here. Please enable at least one
184 // authentication plugin here (auth_*).
185 // Users may enable other user plugins from Preferences/Plugins but may not
186 // disable plugins specified in this list.
187
188 define('CONFIG_VERSION', 26);
189 // Expected config version. Please update this option in config.php
190 // if necessary (after migrating all new options from this file).
191
192 // vim:ft=php
193 ?>