Skip to content

Commit

Permalink
NEWS: Mention config.ini parsing has changed
Browse files Browse the repository at this point in the history
This was an oversight but there is not much we can do now.
#1371

Also clarify the docs.
  • Loading branch information
jtojnar committed Oct 13, 2022
1 parent 157c92f commit 380dd9c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
- Placeholders are now used for images before they are loaded to avoid content jumping around ([#1204](https://github.com/fossar/selfoss/pull/1204))
- Search button is now always on the screen, avoiding the need to scroll to top to be able to use it. ([#1231](https://github.com/fossar/selfoss/issues/1231))
- Button for opening articles, tags, sources and filters in the sidebar, as well as the source and tag links in articles are now real links, allowing to open them in a new tab by middle-clicking them. ([#1216](https://github.com/fossar/selfoss/issues/1216), [#695](https://github.com/fossar/selfoss/issues/695))
- Configuration is no longer managed by F3 framework. ([#1261](https://github.com/fossar/selfoss/pull/1261))
- The way `config.ini` is parsed has changed. If you use any of the following characters `?{}|&~!()^"`, e.g. for database password, you will need to quote the config value like `db_password="life0fD4ng3r!"`. This is a consequence of replacing F3 framework with [PHP’s built-in INI parser](https://www.php.net/manual/en/function.parse-ini-file.php). ([#1261](https://github.com/fossar/selfoss/pull/1261))
- Removed `anonymizer` configuration option. ([#1358](https://github.com/fossar/selfoss/pull/1358))


Expand Down
2 changes: 2 additions & 0 deletions docs/content/docs/administration/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ selfoss can be configured using a configuration file or environment variables. A

This is the easiest way. Just create a `config.ini` file in the top-level selfoss directory and include any options you want to override.

The file uses [PHP’s variant](https://www.php.net/manual/en/function.parse-ini-file.php#refsect1-function.parse-ini-file-examples) of the [INI format](https://en.wikipedia.org/wiki/INI_file): each option is set on a separate line consisting of an option name, followed by `=` and an option value. Lines starting with `;` or empty lines will be ignored. If an option value contains any special characters such as `?{}|&~!()^"`, e.g. for a database password, it will need to be quoted like `db_password="life0fD4ng3r!"`.

For convenience, the release archive includes `config-example.ini` file containing the default configuration exported in INI format. To customize the settings, you can:

1. Rename `config-example.ini` to `config.ini`.
Expand Down

0 comments on commit 380dd9c

Please sign in to comment.