docs/03_For_Hosts/08_Custom_Configuration.md
RSS-Bridge supports custom configurations for common parameters on the server side!
A default configuration file (config.default.ini.php) is shipped with RSS-Bridge.
Please do not edit this file, as it gets replaced when upgrading RSS-Bridge!
You should, however, use this file as template to create your own configuration (or leave it as is, to keep the default settings). In order to create your own configuration perform following actions:
config.ini.php in the RSS-Bridge root folder (next to config.default.ini.php)config.default.ini.php to your configuration fileRSS-Bridge will automatically detect the config.ini.php and use it.
If the file doesn't exist it will default to config.default.ini.php automatically.
Notice: If a parameter is not specified in your config.ini.php RSS-Bridge will
automatically use the default settings from config.default.ini.php.
The configuration file is split into sections:
System: This section specifies system specific parameters
Http client: This section has http client options
Cache: This section is all about the caching behavior of RSS-Bridge
Proxy: This section can be used to specify a proxy server for RSS-Bridge to utilize for fetching contents
Authentication: This section defines parameters to require authentication to use RSS-Bridge
Admin: This section specifies parameters related to the administrator of your instance of RSS-Bridge
This section provides following parameters:
Defines the timezone used by RSS-Bridge. This parameter can be set to any value of the values defined at https://www.php.net/manual/en/timezones.php
The default value is UTC.
This section provides following parameters:
Defines the cache type used by RSS-Bridge.
| Type | Description |
|---|---|
file | File based (default) |
sqlite | SQLite database |
memcached | Memcached service |
Allow users to specify custom timeout for specific requests.
true = enabled
false = disabled (default)
This section provides following parameters:
Sets the proxy url (i.e. "tcp://192.168.0.0:32")
"" = Proxy disabled (default)
Sets the proxy name that is shown on the bridge instead of the proxy url.
"" = Show proxy url (default: "Hidden proxy name")
Allow users to disable proxy usage for specific requests.
true = enabled
false = disabled (default)
This section provides the following parameters:
Default network timeout.
Overrides the user agent value. Note that the default value, together with a set of other detection-preventing options is set automatically by the libcurl-impersonate, which is used by the default Docker container distributed together with RSS-Bridge. Use only if you know what you're doing, otherwise you may stop libcurl-impersonate from doing its job impersonating real browser.
This section provides following parameters:
Enables authentication for RSS-Bridge.
Notice: Login is required for all requests when enabled! Make sure to update feed subscriptions accordingly.
true = enabled
false = disabled (default)
Defines the user name used for login.
Defines the password used for login. Use a strong password to prevent others from guessing your login!
This section provides following parameters:
Advertises an email address where people can reach the administrator.
Notice: This address is displayed on the main page, visible to everyone!
"" = Disabled (default)
Example: email = "[email protected]"
This section provides following parameters:
Defines how error messages are returned by RSS-Bridge
feed: As part of the feed (default)
http: As HTTP error message
none: No errors are reported
Defines how often an error must occur before it is reported to the user
report_limit: 1 (default)