]> git.wh0rd.org - tt-rss.git/blob - config.php-dist
initialize user prefs on update_feeds run
[tt-rss.git] / config.php-dist
1 <?php
2 // Your RDBMS must be configured to accept connections
3 // via TCP/IP and authentified by password.
4
5 define('DB_TYPE', "pgsql"); // or mysql
6 define('DB_HOST', "localhost");
7 define('DB_USER', "fox");
8 define('DB_NAME', "fox");
9 define('DB_PASS', "XXXXXX");
10 //define('DB_PORT', '5432'); // when neeeded, PG-only
11
12 define('RSS_BACKEND_TYPE', "magpie");
13 // magpie (stable) or simplepie (EXPERIMENTAL!)
14
15 define('MAGPIE_FETCH_TIME_OUT', 60);
16 // Magpie's default timeout is 5 seconds. Some RSS feeds,
17 // such as from large Trac installs, can take significantly
18 // longer than 5 seconds to generate. To prevent failed
19 // updates, increase this.
20
21 define('MAGPIE_CACHE_DIR', '/var/tmp/magpie-ttrss-cache');
22 // Local cache directory for RSS feeds
23
24 define('SIMPLEPIE_CACHE_DIR', '/var/tmp/simplepie-ttrss-cache');
25 // Local cache directory for RSS feeds (simplepie)
26
27 define('WEB_DEMO_MODE', false);
28 // Demo mode with reduced functionality.
29 // Warning: this option is obsolete. Don't rely on it being
30 // checked in all necessary places.
31
32 define('ICONS_DIR', "icons");
33 define('ICONS_URL', "icons");
34 // Local and URL path to the directory, where feed favicons are stored.
35
36 define('USE_HTTP_AUTH', false);
37 // Use HTTP Basic authentication instead of login form. Has some problems.
38
39 define('SINGLE_USER_MODE', true);
40 // Operate in single user mode, disables all functionality related to
41 // multiple users.
42
43 define('DAEMON_REFRESH_ONLY', false);
44 // updates to all feeds will only run when the backend script is
45 // invoked with a "daemon" option on the URI stem. This is useful when you
46 // are hosting multi-user system and want to control how often
47 // feeds are being updated.
48
49 // An example wget command line below will invoke an update every 30
50 // minutes, with output being sent to /dev/null and the timeout set to
51 // 10 minutes so that wget does not time out. Substitute your site name
52 // and tt-rss path as necessary.
53 //
54 // */30 * * * * /usr/bin/wget -O /dev/null -T 600 "http://www.your-site.xxx/tt-rss/backend.php?op=globalUpdateFeeds&daemon=1"
55 //
56
57 // The alternative approach is to run update_feeds.php from your crontab
58 // with command line PHP interpreter. Don't forget to chdir() into TT-RSS
59 // directory or it won't be able to find includes. E.g.
60 //
61 // */30 * * * * cd $TTRSS_DIRECTORY && ./update_feeds.php >/dev/null 2>&1
62
63 // Another alternative approach is to run update_daemon.php in the background
64 // on the server, which allows user-scheduled updates and continous
65 // feed updating in the background. This is the recommended way at the moment.
66
67 define('SMART_RPC_COUNTERS', false);
68 // If enabled, stores feed counter information on the server side and sends
69 // only diffs to the client. In the nutshell, it saves your bandwidth and
70 // makes UI more responsive, but eats server memory.
71 // This option can introduce a lot of weird interface glitches in
72 // some use-cases (if you have more than one tt-rss window open, for example)
73 // so it is disabled by default.
74
75 define('GLOBAL_ENABLE_LABELS', false);
76 // Labels are a security risk, so this option can globally disable them for all users.
77
78 define('ENABLE_LOGIN_SSL', false);
79 // Redirect to SSL url for login
80
81 define('MAIL_RESET_PASS', true);
82 // Send mail to user on password reset
83
84 define('MAIL_FROM', 'TT-RSS Daemon <noreply@some.ttrss.host.dom>');
85 // Pretty obvious, I suppose. Used for email digests & password notifications.
86
87 define('ENABLE_FEED_BROWSER', true);
88 // Enable or disable local feed browser
89
90 define('TMP_DIRECTORY', '/tmp');
91 // Directory for temporary files
92
93 define('FEEDS_FRAME_REFRESH', 600);
94 // Auto refresh interval for feeds frame (in seconds)
95
96 define('MAX_UPDATE_TIME', 0);
97 // Limit one update sequence run to this number of seconds.
98 // The valiue is not exact, because it is being checked between feed updates,
99 // which could use abritrary amount of time. Feeds which could not be updated
100 // in time, are being skipped.
101 // If this option is enabled (non-zero) feeds are updated in random order.
102 // It is also recommended to set FEEDS_FRAME_REFRESH to a lower value if using
103 // this option.
104
105 define('ENABLE_UPDATE_DAEMON', false);
106 // This enables different mechanism for user-triggered updates designed
107 // for update daemon running in background on the server.
108 // This option suggests FEEDS_FRAME_REFRESH set to a small value
109 // (like 60 seconds, depending on number of users and server/bandwidth load).
110
111 define('DAEMON_SLEEP_INTERVAL', 120);
112 // Interval between update daemon update runs
113
114 define('DATABASE_BACKED_SESSIONS', false);
115 // Store session information in a database, recommended for multiuser
116 // configurations. Doesn't seem to work for everyone, so enable with caution.
117 // tt-rss uses default PHP session storing mechanism if disabled.
118
119 define('SESSION_CHECK_ADDRESS', true);
120 // Bind session to client IP address (recommended)
121
122 define('SESSION_COOKIE_LIFETIME', 0);
123 // Default lifetime of a session cookie. In seconds,
124 // 0 means delete on browser close
125
126 define('SESSION_COOKIE_LIFETIME_REMEMBER', 86400);
127 // Session cookie lifetime if "remember me" is checked on login.
128
129 define('SESSION_EXPIRE_TIME', 86400);
130 // Hard expiration limit for sessions. Should be
131 // >= SESSION_COOKIE_LIFETIME_REMEMBER
132
133 define('DAEMON_UPDATE_LOGIN_LIMIT', 0);
134 // Stop updating feeds of user who was never logged in
135 // in specified amount of days. 0 disables.
136
137 define('CHECK_FOR_NEW_VERSION', true);
138 // Check for new versions of tt-rss when entering preferences.
139
140 define('USE_CURL_FOR_ICONS', false);
141 // Fetch favicons using CURL, useful if your PHP has disabled remote fopen()
142
143 define('DIGEST_ENABLE', true);
144 // Global option to enable daily digests
145
146 define('DIGEST_HOSTNAME', 'some.ttrss.host.dom');
147 // Hostname for email digest signature
148
149 define('DIGEST_EMAIL_LIMIT', 10);
150 // The maximum amount of emails sent in one digest batch
151
152 define('DAEMON_SENDS_DIGESTS', true);
153 // If update daemon and update_feeds should send digests
154 // Disable if you prefer querying special URL (see wiki)
155
156 define('CONFIG_VERSION', 5);
157 // Expected config version. Please update this option in config.php
158 // if necessary (after migrating all new options from this file).
159
160 // vim:ft=php
161 ?>