Skip to content

Commit f54224a

Browse files
committed
More assorted content tweaks.
1 parent 05e6e74 commit f54224a

File tree

5 files changed

+22
-28
lines changed

5 files changed

+22
-28
lines changed

docs/API-Reference.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ title: API Reference
44
nav_order: 60
55
---
66

7-
{: .no_toc }
8-
97
## Table of contents
108
{: .no_toc .text-delta }
119

12-
1. TOC
10+
- TOC
1311
{:toc}
1412

1513
---

docs/FAQ.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ nav_order: 3
77
{: .note }
88
> [Docker-related stuff is on a separate page](Installation-Guide#faq)
99
10-
{: .no_toc }
11-
1210
## Table of contents
1311
{: .no_toc .text-delta }
1412

docs/Global-Config.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,16 @@ title: Global Configuration
44
nav_order: 4
55
---
66

7-
All settings (see `_DEFAULTS[]` for default values) are listed here:
7+
## Table of contents
8+
{: .no_toc .text-delta }
89

9-
- <https://github.com/tt-rss/tt-rss/blob/main/classes/Config.php> (source code, including default values)
10+
- TOC
11+
{:toc}
12+
13+
## tt-rss configuration
14+
15+
All tt-rss settings may be found in <https://github.com/tt-rss/tt-rss/blob/main/classes/Config.php>; the default values are in `_DEFAULTS`.
16+
You might find the [`Prefs_Effective_Config`](https://github.com/tt-rss/tt-rss-plugin-prefs-effective-config) plugin helpful.
1017

1118
It is preferred to adjust tt-rss global configuration through the environment (e.g. using your Docker `.env` file):
1219

@@ -24,7 +31,7 @@ putenv('TTRSS_DB_HOST=myserver');
2431
putenv('TTRSS_SESSION_COOKIE_LIFETIME='.(86400*30));
2532
```
2633

27-
- Note lack of quotes around values.
34+
- Note the lack of quotes around values.
2835
- Options should be always prefixed by `TTRSS_`.
2936
- Don't modify `classes/config.php`.
3037
- You don't need to put everything to `config.php`, only the options which you've changed from the defaults.
@@ -35,13 +42,13 @@ Legacy plugin-required constants also go to `config.php`, using `define()`:
3542
define('LEGACY_CONSTANT', 'value');
3643
```
3744

38-
To set computed values via `putenv()` you have to get them evaluated by PHP, this would work:
45+
To set computed values via `putenv()` you have to get them evaluated by PHP, so this would work:
3946

4047
```js
4148
putenv('TTRSS_SESSION_COOKIE_LIFETIME='.(86400*30));
4249
```
4350

44-
However, these won't give you expected results:
51+
However, these won't give you the expected results:
4552

4653
```js
4754
putenv("TTRSS_SESSION_COOKIE_LIFETIME='2592000'");
@@ -57,7 +64,7 @@ putenv('TTRSS_SESSION_COOKIE_LIFETIME=86400*30');
5764
5865
## Minimal config.php for a non-Docker setup
5966

60-
Should have at least these options defined:
67+
You should have at least these options defined:
6168

6269
```php
6370
<?php
@@ -70,7 +77,12 @@ putenv('TTRSS_SELF_URL_PATH=http://example.com/tt-rss/'); # fully-qualified URL
7077
putenv('TTRSS_PHP_EXECUTABLE=/path/to/php-cli-binary'); # normally something like /usr/bin/php
7178
```
7279

73-
## Migrating from old style config.php
80+
{: .note }
81+
> In recent versions of tt-rss you may be able to omit `TTRSS_SELF_URL_PATH` and
82+
> rely on auto-detection, but it should be set if you use email digests or other background
83+
> processes that need your instance's URL (or if you run into issues).
84+
85+
## Migrating from the old-style config.php
7486

7587
For any `config.php` settings you have changed from the defaults (normally this
7688
is the `DB_` group of settings and `SELF_URL_PATH`, replace as follows, using

docs/Installation-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ APP_WEB_ROOT=/var/www/html/tt-rss
239239
APP_BASE=
240240
```
241241

242-
Don't forget to remove `/tt-rss/` from `TTRSS_SELF_URL_PATH`.
242+
Don't forget to remove `/tt-rss/` from `TTRSS_SELF_URL_PATH` (if you have it set).
243243

244244
### How do I apply configuration options?
245245

index.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ description: "Tiny Tiny RSS (tt-rss) is a free, flexible, open-source, web-based
66
permalink: /
77
---
88

9-
{: .no_toc }
10-
119
Tiny Tiny RSS (tt-rss) is a free, flexible, open-source, web-based news feed (RSS/Atom/other) reader and aggregator.
1210

1311
## Screenshots
@@ -55,19 +53,7 @@ See the [Installation Guide](docs/Installation-Guide.md) for detailed instructio
5553
* Go to [https://github.com/tt-rss/tt-rss/discussions](https://github.com/tt-rss/tt-rss/discussions) if you have questions or want to discuss something.
5654
* Go to [https://github.com/tt-rss/tt-rss/issues](https://github.com/tt-rss/tt-rss/issues) if you want to report an issue, request an enhancement/feature, etc.
5755

58-
## Documentation
59-
60-
Browse the documentation:
61-
62-
- [Installation Guide](docs/Installation-Guide.md)
63-
- [API Reference](docs/API-Reference.md)
64-
- [Plugins](docs/Plugins.md) and [Making Plugins](docs/Making-Plugins.md)
65-
- [Themes](docs/Themes.md)
66-
- [Content Filters](docs/Content-Filters.md)
67-
- [FAQ](docs/FAQ.md)
68-
- [Global Configuration](docs/Global-Config.md)
69-
70-
## Development and Contributing
56+
## Development and contributing
7157

7258
Contributions (code, translations, reporting issues, etc.) are welcome.
7359
Please see <https://github.com/tt-rss/tt-rss/blob/main/CONTRIBUTING.md> for more information.

0 commit comments

Comments
 (0)