[CustomConfiguration] Create new page

Custom-Configuration.md

@@ -0,0 +1,65 @@
+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:
+
+* Create the file `config.ini.php` in the RSS-Bridge root folder (next to `config.default.ini.php`)
+* Copy the contents from `config.default.ini.php` to your configuration file
+* Change the parameters to satisfy your requirements
+
+RSS-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`.
+
+# Available parameters
+
+The configuration file is split into two sections:
+
+* [cache](#cache)
+* [proxy](#proxy)
+
+_Cache_: This section is all about the caching behaviour of RSS-Bridge
+_Proxy_: This section can be used to specify a proxy server for RSS-Bridge to utilize for fetching contents
+
+## Cache
+
+This section provides following parameters:
+
+- [custom_timeout](#custom_timeout)
+
+### custom_timeout
+
+Allow users to specify custom timeout for specific requests.
+
+`true` = enabled
+
+`false` = disabled (default)
+
+## Proxy
+
+This section provides following parameters:
+
+- [url](#url)
+- [name](#name)
+- [by_bridge](#by_bridge)
+
+### url
+
+Sets the proxy url (i.e. "tcp://192.168.0.0:32")
+
+`""` = Proxy disabled (default)
+
+### name
+
+Sets the proxy name that is shown on the bridge instead of the proxy url.
+
+`""` = Show proxy url (default: "Hidden proxy name")
+
+### by_bridge
+
+Allow users to disable proxy usage for specific requests.
+
+`true`  = enabled
+
+`false` = disabled (default)