]> git.wh0rd.org Git - tt-rss.git/blob - config.php-dist
update NEWS
[tt-rss.git] / config.php-dist
1 <?
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('MAGPIE_CACHE_DIR', '/var/tmp/magpie-ttrss-cache');
13         // Local cache directory for RSS feeds
14         
15         define('WEB_DEMO_MODE', false);
16         // Demo mode with reduced functionality.
17
18         define('ICONS_DIR', "icons");
19         define('ICONS_URL', "icons");
20         // Local and URL path to the directory, where feed favicons are stored.
21
22         define('USE_HTTP_AUTH', false);
23         // Use HTTP Basic authentication instead of login form. Has some problems.
24
25         define('SINGLE_USER_MODE', true);
26         // Operate in single user mode, disables all functionality related to
27         // multiple users.
28
29         define('DAEMON_REFRESH_ONLY', false);
30         // updates to all feeds will only run when the backend script is
31         // invoked with a "daemon" option on the URI stem. This is useful when you
32         // are hosting multi-user system and want to control how often 
33         // feeds are being updated.
34         
35         // An example wget command line below will invoke an update every 30 
36         // minutes, with output being sent to /dev/null and the timeout set to 
37         // 10 minutes so that wget does not time out. Substitute your site name
38         // and tt-rss path as necessary.
39         //
40         // */30 * * * * /usr/bin/wget -O /dev/null -T 600 "http://www.your-site.xxx/tt-rss/backend.php?op=globalUpdateFeeds&daemon=1"
41         //
42
43         // The alternative approach is to run update_feeds.php from your crontab
44         // with command line PHP interpreter. Don't forget to chdir() into TT-RSS
45         // directory or it won't be able to find includes. E.g.
46         //
47         // */30 * * * * cd $TTRSS_DIRECTORY && ./update_feeds.php >/dev/null 2>&1
48
49         // Another alternative approach is to run update_daemon.php in the background
50         // on the server, which allows user-scheduled updates and continous
51         // feed updating in the background. This is the recommended way at the moment.
52         
53         define('SMART_RPC_COUNTERS', false);
54         // If enabled, stores feed counter information on the server side and sends
55         // only diffs to the client. In the nutshell, it saves your bandwidth and
56         // makes UI more responsive, but eats server memory.
57         // This option can introduce a lot of weird interface glitches in
58         // some use-cases (if you have more than one tt-rss window open, for example)
59         // so it is disabled by default.
60
61         define('GLOBAL_ENABLE_LABELS', false);
62         // Labels are a security risk, so this option can globally disable them for all users.
63
64         define('ENABLE_LOGIN_SSL', false);
65         // Redirect to SSL url for login
66
67         define('MAIL_RESET_PASS', true);
68         // Send mail to user on password reset
69         
70         define('MAIL_FROM', 'TT-RSS Daemon <noreply@ttrss.your-shiny-host.org>');
71         // Pretty obvious, I suppose.
72
73         define('ENABLE_FEED_BROWSER', true);
74         // Enable or disable local feed browser
75
76         define('TMP_DIRECTORY', '/tmp');
77         // Directory for temporary files
78
79         define('FEEDS_FRAME_REFRESH', 600);
80         // Auto refresh interval for feeds frame (in seconds)
81
82         define('MAX_UPDATE_TIME', 0);
83         // Limit one update sequence run to this number of seconds.
84         // The valiue is not exact, because it is being checked between feed updates,
85         // which could use abritrary amount of time.    Feeds which could not be updated
86         // in time, are being skipped.
87         // If this option is enabled (non-zero) feeds are updated in random order.
88         // It is also recommended to set FEEDS_FRAME_REFRESH to a lower value if using
89         // this option.
90
91         define('ENABLE_UPDATE_DAEMON', false);
92         // This enables different mechanism for user-triggered updates designed
93         // for update daemon running in background on the server.
94         // This option suggests FEEDS_FRAME_REFRESH set to a small value 
95         // (like 60 seconds, depending on number of users and server/bandwidth load).
96
97         define('DAEMON_SLEEP_INTERVAL', 120);
98         // Interval between update daemon update runs
99
100         define('DATABASE_BACKED_SESSIONS', false);
101         // Store session information in a database, recommended for multiuser 
102         // configurations. Doesn't seem to work for everyone, so enable with caution.
103         // tt-rss uses default PHP session storing mechanism if disabled.
104
105         define('SESSION_CHECK_ADDRESS', true);
106         // Bind session to client IP address (recommended)
107
108         define('SESSION_COOKIE_LIFETIME', 0);
109         // Default lifetime of a session cookie. In seconds, 
110         // 0 means delete on browser close
111
112         define('SESSION_COOKIE_LIFETIME_REMEMBER', 86400);
113         // Session cookie lifetime if "remember me" is checked on login.
114
115         define('SESSION_EXPIRE_TIME', 86400);
116         // Hard expiration limit for sessions. Should be
117         // >= SESSION_COOKIE_LIFETIME_REMEMBER
118
119         define('CONFIG_VERSION', 1);
120         // Expected config version. Please updated this option in config.php
121         // if necessary (after migrating all new options from this file).
122
123         define('DAEMON_UPDATE_LOGIN_LIMIT', 30);
124         // Stop updating feeds of user who was never logged in
125         // in specified amount of days. 0 disables.
126
127         // vim:ft=php
128 ?>