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