Skip to content

Commit b45318e

Browse files
committed
docs: Mention debug key
This already existed in 2.19 but was not documented.
1 parent b899621 commit b45318e

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

NEWS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
- Spouts can fetch item contents lazily by passing a function as `content` to `Item`. ([#1413](https://github.com/fossar/selfoss/pull/1413))
3535
- Spouts’ `name`, `description` and `params` properties now require a type hint. ([#1425](https://github.com/fossar/selfoss/pull/1425))
3636
- All classes other than spouts were made final. ([#1546](https://github.com/fossar/selfoss/pull/1546))
37+
- The debugging level (in selfoss ≤ 2.18 set by modifying `src/common.php`) can be changed in the `config.ini` using `debug` key. ([#1298](https://github.com/fossar/selfoss/pull/1298))
3738

3839
### Other changes
3940
- `tidy` PHP extension is now required if you want to use “Content extractor” spout. ([#1392](https://github.com/fossar/selfoss/pull/1392))

docs/content/docs/administration/options.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,16 @@ Port for database connections. By default `3306` will be used for MySQL and `543
5959
A UNIX domain socket used for connecting to the MySQL database server. Usually, you want to use `db_host=localhost`, which should use the default socket path (typically `/run/mysqld/mysqld.sock` for MySQL or `/run/postgresql` for PostgreSQL) but if you need to specify a different location, you can. This is orthogonal to `db_host` option.
6060
</div>
6161

62+
### `debug`
63+
<div class="config-option">
64+
65+
Level of detail for diagnostics. Enable this for debug traces if you encounter selfoss internal errors or are developing selfoss.
66+
67+
* `0` (default) – Debugging is disabled, errors will only be [logged](#logger-level).
68+
* `1` – Debugging is enabled, any error or warning will terminate the application and cause debugging information to be printed into the web browser.
69+
* `2` – Same as `1` but additional information (HTTP requests) will be logged when fetching feed content.
70+
</div>
71+
6272
### `logger_destination`
6373
<div class="config-option">
6474

src/helpers/Configuration.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@ final class Configuration {
4949

5050
// Internal but overridable values.
5151

52-
/** Debugging level @internal */
53-
public int $debug = 0;
54-
5552
/** @internal */
5653
public string $datadir = __DIR__ . '/../../data';
5754

@@ -63,6 +60,9 @@ final class Configuration {
6360

6461
// Rest of the values.
6562

63+
/** Debugging level */
64+
public int $debug = 0;
65+
6666
public string $dbType = 'sqlite';
6767

6868
public string $dbFile = '%datadir%/sqlite/selfoss.db';

0 commit comments

Comments
 (0)