1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
% Global configuration
All settings (see `_DEFAULTS[]` for default values) are listed here:
- https://srv.tt-rss.org/ttrss-docs/classes/Config.html (auto-generated class documentation)
- https://git.tt-rss.org/fox/tt-rss.git/tree/classes/Config.php (source code, including default values)
---------------
It is preferred to adjust tt-rss global configuration through the environment, i.e. defined in `.env` when using docker-compose setup:
```ini
# Copy this file to .env before building the container.
# Put any local modifications here.
TTRSS_SELF_URL_PATH=http://127.0.0.1/tt-rss
```
Alternatively, you can **create** `config.php` in tt-rss root directory (copied from `config.php-dist`), using the following syntax:
```php
putenv('TTRSS_DB_HOST=myserver');
putenv('TTRSS_SELF_URL_PATH=http://example.com/tt-rss');
putenv('TTRSS_SESSION_COOKIE_LIFETIME='.(86400*30));
```
- Note lack of quotes around values.
- Options should be always prefixed by `TTRSS_`.
- Don't modify `classes/config.php`.
- You don't need to put everything to `config.php`, only the options which you've changed from the defaults.
Legacy plugin-required constants also go to `config.php`, using `define()`:
```php
define('LEGACY_CONSTANT', 'value');
```
To set computed values via `putenv()` you have to get them evaluated by PHP, this would work:
```php
putenv('TTRSS_SESSION_COOKIE_LIFETIME='.(86400*30));
```
However, these won't give you expected results:
```php
putenv("TTRSS_SESSION_COOKIE_LIFETIME='2592000'");
# => 0, because '2592000' is an invalid number
putenv('TTRSS_SESSION_COOKIE_LIFETIME=86400*30');
# => 86400, right side expression is not evaluated, instead you're casting string literal "86400*30" to integer
```
Note that all values should be precomputed when setting via `.env` because they are not evaluated by PHP and used as-is.
## Minimal config.php for a non-Docker setup
Should have at least these options defined:
```php
<?php
putenv('TTRSS_DB_TYPE=pgsql'); # or mysql
putenv('TTRSS_DB_HOST=mydbhost');
putenv('TTRSS_DB_USER=mydbuser');
putenv('TTRSS_DB_PASS=mydbpass');
putenv('TTRSS_DB_PORT=5432'); # or 3306
putenv('TTRSS_SELF_URL_PATH=http://example.com/tt-rss/'); # fully-qualified URL of your tt-rss install
putenv('TTRSS_PHP_EXECUTABLE=/path/to/php-cli-binary'); # normally something like /usr/bin/php
```
## Migrating from old-style config.php
For any `config.php` settings you have changed from the defaults (normally this is the `DB_` group of settings and `SELF_URL_PATH`, replace as follows, using the rules above:
`define('DB_PORT', 'xxx')` → `putenv('TTRSS_DB_PORT=xxx')`.
You can safely omit any settings that were at default values.
[This thread](https://community.tt-rss.org/t/rip-config-php-hello-classes-config-php/4337/30) has relevant discussion and many examples.
|
