mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-08-03 17:44:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Do not use constants for configuration (#2938)

Browse source 
* docs: Do not use constant names when referring to config options

The options are customizable using a config file and no longer hardcoded in index.php since 8ac8e08abf

* Do not use constants for configuration

Since <8ac8e08abf>, they are just set to the configuration object values.
This commit is contained in:
Jan Tojnar 2022-07-24 19:26:12 +02:00 • committed by GitHub
parent 499d5c2b77
commit 5b5f3b4254
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 15 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/02_CLI/index.md
View file

@ -27,9 +27,9 @@ This parameter specifies the format in which RSS-Bridge returns the contents. RS
RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script.
### _noproxy
### \_noproxy
This parameter is only available if a proxy server has been specified via `PROXY_URL` and 'PROXY_BYBRIDGE' has been enabled. This is a Boolean parameter that can be set to '1' (true) or '0' (false).
This parameter is only available if a proxy server has been specified via `proxy.url` and `proxy.by_bridge` has been enabled. This is a Boolean parameter that can be set to `true` or `false`.
## Bridge parameters

6
docs/03_For_Hosts/07_Customizations.md
View file

@ -1,9 +1,9 @@
RSS-Bridge ships a few options the host may or may not activate. All options are currently defined in the [index.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/index.php) file. This means they'll be reset after upgrading RSS-Bridge!
RSS-Bridge ships a few options the host may or may not activate. All options are listed in the [config.default.ini.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/config.default.ini.php) file, see [Custom Configuration](08_Custom_Configuration.md) section for more information.
## Customizable cache timeout
Sometimes it is necessary to specify custom timeouts to update contents more frequently than the bridge maintainer intended. In these cases the client may specify a custom cache timeout to prevent loading contents from cache earlier (or later).
This option can be activated by setting the `CUSTOM_CACHE_TIMEOUT` to `true`. When enabled each bridge receives an additional parameter `Cache timeout in seconds` that can be set to any value between 1 and 86400 (24 hours). If the value is not within the limits the default settings apply (as specified by the bridge maintainer).
This option can be activated by setting the [`cache.custom_timeout`](08_Custom_Configuration.md#custom_timeout) option to `true`. When enabled each bridge receives an additional parameter `Cache timeout in seconds` that can be set to any value between 1 and 86400 (24 hours). If the value is not within the limits the default settings apply (as specified by the bridge maintainer).
The cache timeout is send to RSS-Bridge using the `_cache_timeout` parameter. RSS-Bridge will return an error message if the parameter is received and the option is disabled.
The cache timeout is send to RSS-Bridge using the `_cache_timeout` parameter. RSS-Bridge will return an error message if the parameter is received and the option is disabled.

4
docs/03_For_Hosts/08_Custom_Configuration.md
View file

@ -17,7 +17,7 @@ __Notice__: If a parameter is not specified in your `config.ini.php` RSS-Bridge
The configuration file is split into sections:
* [system](#system)
* [http client](#http client)
* [http client](#http-client)
* [cache](#cache)
* [proxy](#proxy)
* [authentication](#authentication)
@ -179,4 +179,4 @@ Defines how error messages are returned by RSS-Bridge
Defines how often an error must occur before it is reported to the user
`report_limit`: 1 (default)
`report_limit`: 1 (default)