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