mirrors/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2024-12-18 08:54:20 +03:00
Code Issues Projects Releases Packages Wiki Activity
rss-bridge/config.default.ini.php

165 lines
4.3 KiB
PHP
Raw Normal View History

Add user config (#653) Uses the parse_ini_file function to load default settings from the default configuration file 'config.default.ini.php'. Optionally loads custom settings from 'config.ini.php' to replace the default values.
2018-05-29 12:52:17 +03:00
; <?php exit; ?> DO NOT REMOVE THIS LINE
; This file contains the default settings for RSS-Bridge. Do not change this
; file, it will be replaced on the next update of RSS-Bridge! You can specify
; your own configuration in 'config.ini.php' (copy this file).
config: Add [system] => 'timezone' RSS-Bridge currently statically sets the timezone to UTC which can result in incorrect timestamps if the server is hosted in another region. This commit adds a new configuration parameter to allow admins to specify their own timezone for their servers. Invalid values will result in an error message. Example: [system] timezone = "UTC" For compatibility reasons the default value is set to UTC. This parameter accepts any of the supported timezones listed at https://www.php.net/manual/en/timezones.php Closes #956 References #1001
2019-06-07 20:19:36 +03:00
[system]
feat: enable bridges using env var (#3428) * refactor: bridgefactory, add tests * refactor: move defaultly enabled bridges to config * refactor * refactor * feat: add support for enabling bridges with env var
2023-06-11 04:16:03 +03:00
; Only these bridges are available for feed production
fix: bug in #3442 (#3498) * fix: bug in #3442 * docs: add inline doc on how to enable all bridges
2023-07-06 16:20:56 +03:00
; How to enable all bridges: enabled_bridges[] = *
feat: enable all bridges by default (#4177)
2024-07-31 18:53:10 +03:00
;enabled_bridges[] = CssSelectorBridge
;enabled_bridges[] = FeedMerge
;enabled_bridges[] = FeedReducerBridge
;enabled_bridges[] = Filter
;enabled_bridges[] = GettrBridge
;enabled_bridges[] = MastodonBridge
;enabled_bridges[] = Reddit
;enabled_bridges[] = RumbleBridge
;enabled_bridges[] = SoundcloudBridge
;enabled_bridges[] = Telegram
;enabled_bridges[] = ThePirateBay
;enabled_bridges[] = TikTokBridge
;enabled_bridges[] = Twitch
;enabled_bridges[] = Vk
;enabled_bridges[] = XPathBridge
;enabled_bridges[] = Youtube
;enabled_bridges[] = YouTubeCommunityTabBridge
enabled_bridges[] = *
feat: enable bridges using env var (#3428) * refactor: bridgefactory, add tests * refactor: move defaultly enabled bridges to config * refactor * refactor * feat: add support for enabling bridges with env var
2023-06-11 04:16:03 +03:00
config: Add [system] => 'timezone' RSS-Bridge currently statically sets the timezone to UTC which can result in incorrect timestamps if the server is hosted in another region. This commit adds a new configuration parameter to allow admins to specify their own timezone for their servers. Invalid values will result in an error message. Example: [system] timezone = "UTC" For compatibility reasons the default value is set to UTC. This parameter accepts any of the supported timezones listed at https://www.php.net/manual/en/timezones.php Closes #956 References #1001
2019-06-07 20:19:36 +03:00
; Defines the timezone used by RSS-Bridge
; Find a list of supported timezones at
; https://www.php.net/manual/en/timezones.php
; timezone = "UTC" (default)
timezone = "UTC"
feat: system alert message (#3139)
2022-11-15 02:32:04 +03:00
; Display a system message to users.
message = ""
fix: move debug mode to config (#3324) * fix: move debug mode to config * fix: also move debug_whitelist to .ini config * fix: move logic back to Debug class * docs * docs * fix: disable debug mode by default * fix: restore previous behavior for alerts * fix: center-align alert text
2023-06-02 21:22:09 +03:00
; Whether to enable debug mode.
enable_debug_mode = false
; Enable debug mode only for these permitted ip addresses
; debug_mode_whitelist[] = 127.0.0.1
; debug_mode_whitelist[] = 192.168.1.10
feat: add system config enable_maintenance_mode (#3497)
2023-07-06 16:09:44 +03:00
; Whether to enable maintenance mode. If enabled, feed requests receive 503 Service Unavailable
enable_maintenance_mode = false
feat: extract curl ua to config value (#2568) * exclude config.default.ini.php from phpcs
2022-04-03 10:37:39 +03:00
[http]
feat: embed response in http exception (#3847)
2023-12-20 05:16:25 +03:00
; Operation timeout in seconds
feat: add etag support to getContents (#3893)
2024-01-12 03:31:01 +03:00
timeout = 15
feat(http-client): add http retry count to config (#3887)
2024-01-10 23:48:12 +03:00
; Operation retry count in case of curl error
retries = 2
; User agent
fix: change default curl user agent (#2926)
2022-07-31 04:58:07 +03:00
useragent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Firefox/102.0"
feat: extract curl ua to config value (#2568) * exclude config.default.ini.php from phpcs
2022-04-03 10:37:39 +03:00
feat: add max file size to http responses (#3140)
2022-11-16 19:56:26 +03:00
; Max http response size in MB
max_filesize = 20
Add user config (#653) Uses the parse_ini_file function to load default settings from the default configuration file 'config.default.ini.php'. Optionally loads custom settings from 'config.ini.php' to replace the default values.
2018-05-29 12:52:17 +03:00
[cache]
fix: rewrite and improve caching (#3594)
2023-09-10 22:50:15 +03:00
; Cache type: file, sqlite, memcached, array, null
core: Add support for custom cache types via config.ini.php This commit adds support for a new parameter which specifies the type of cache to use for caching. It is specified in config.ini.php: [cache] type = "..." Currently only one type of cache is supported (see /caches). All uses of 'FileCache' were replaced by this configuration option. Note: Caching currently depends on files and folders (due to FileCache). Experience may vary depending on the selected cache type. For now always check if FileCache is working before testing alternative types. References #1000
2019-02-06 20:52:44 +03:00
type = "file"
Add user config (#653) Uses the parse_ini_file function to load default settings from the default configuration file 'config.default.ini.php'. Optionally loads custom settings from 'config.ini.php' to replace the default values.
2018-05-29 12:52:17 +03:00
; Allow users to specify custom timeout for specific requests.
; true = enabled
; false = disabled (default)
custom_timeout = false
core: Display optional administrator email (#896)
2018-11-05 12:46:44 +03:00
[admin]
; Advertise an email address where people can reach the administrator.
; This address is displayed on the main page, visible to everyone!
; "" = Disabled (default)
email = ""
feat: add admin telegram contact config (#3134)
2022-11-07 20:36:52 +03:00
; Advertise a contact Telegram url e.g. "https://t.me/elegantobjects"
telegram = ""
[core] Support for bridge maintainers' donation URLs (#2102)
2021-06-25 22:45:25 +03:00
; Show Donation information for bridges if available.
; This will display a 'Donate' link on the bridge view
; and a "Donate" button in the HTML view of the bridges feed.
; true = enabled (default)
; false = disabled
donations = true
Add user config (#653) Uses the parse_ini_file function to load default settings from the default configuration file 'config.default.ini.php'. Optionally loads custom settings from 'config.ini.php' to replace the default values.
2018-05-29 12:52:17 +03:00
[proxy]
refactor: frontpage and proxy setting (#4214)
2024-08-18 20:11:11 +03:00
; The HTTP proxy to tunnel requests through
; https://curl.se/libcurl/c/CURLOPT_PROXY.html
Add user config (#653) Uses the parse_ini_file function to load default settings from the default configuration file 'config.default.ini.php'. Optionally loads custom settings from 'config.ini.php' to replace the default values.
2018-05-29 12:52:17 +03:00
; "" = Proxy disabled (default)
url = ""
; Sets the proxy name that is shown on the bridge instead of the proxy url.
; "" = Show proxy url
name = "Hidden proxy name"
; Allow users to disable proxy usage for specific requests.
; true = enabled
; false = disabled (default)
Add basic authentication support (#728) * Move configuration in its own class in order to reduce the verbosity of index.php * Add authentication mechanism using HTTP auth * Add a method to get the config parameters * Remove the installation checks from the index page * Log all failed authentication attempts
2018-06-27 20:09:41 +03:00
by_bridge = false
Adopt WebDriverAbstract as a solution for active (JavaScript) websites (#3971) * first working version --------- Co-authored-by: Dag <me@dvikan.no>
2024-02-10 06:42:22 +03:00
[webdriver]
; Sets the url of the webdriver or selenium server
selenium_server_url = "http://localhost:4444"
; Sets whether the browser should run in headless mode (no visible ui)
; true = enabled
; false = disabled (default)
headless = false
Add basic authentication support (#728) * Move configuration in its own class in order to reduce the verbosity of index.php * Add authentication mechanism using HTTP auth * Add a method to get the config parameters * Remove the installation checks from the index page * Log all failed authentication attempts
2018-06-27 20:09:41 +03:00
[authentication]
feat: token authentication (#3927)
2024-01-25 20:20:02 +03:00
; HTTP basic authentication
Add basic authentication support (#728) * Move configuration in its own class in order to reduce the verbosity of index.php * Add authentication mechanism using HTTP auth * Add a method to get the config parameters * Remove the installation checks from the index page * Log all failed authentication attempts
2018-06-27 20:09:41 +03:00
enable = false
refactor: general code base refactor (#2950) * refactor * fix: bug in previous refactor * chore: exclude phpcompat sniff due to bug in phpcompat * fix: do not leak absolute paths * refactor/fix: batch extensions checking, fix DOS issue
2022-08-06 23:46:28 +03:00
username = "admin"
fix: disallow usage of default password (#3284)
2023-03-06 22:43:44 +03:00
password = ""
caches: Refactor the API (#1060) - For consistency, functions should always return null on non-existing data. - WordPressPluginUpdateBridge appears to have used its own cache instance in the past. Obviously not used anymore. - Since $key can be anything, the cache implementation must ensure to assign the related data reliably; most commonly by serializing and hashing the key in an appropriate way. - Even though the default path for storage is perfectly fine, some people may want to use a different location. This is an example how a cache implementation is responsible for its requirements.
2019-04-29 21:12:43 +03:00
feat: token authentication (#3927)
2024-01-25 20:20:02 +03:00
; Token authentication (URL)
token = ""
[core] Implement bearer token authentication (#3043)
2022-10-19 19:39:35 +03:00
core: Add an option to return errors in different formats (#1071) Bridge errors are currently included as part of the feed to notify users about erroneous bridges (before that, bridges silently failed). This solution, however, can produce a high load of error messages if servers are down (see #994 for more details). Admins may also not want to include error messages in feeds in order to keep those kind of problems away from users or simply to silently fail by choice. This commit adds a new configuration section "error" with one option "output" which can be set to following values: "feed": To include error messages in the feed (default) "http": To return a HTTP header for each error "none": To disable error reporting Note that errors are always logged to 'error.log' independent of the settings above. Closes #1066
2019-10-31 20:40:51 +03:00
[error]
; 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
output = "feed"
core: Add an option to suppress error reporting (#1179) Error reporting currently takes place for each error. This can result in many error messages if a server has connectivity issues (i.e. when it re-connects to the internet every 24 hours). This commit adds a new option to the configuration file to define the number of error reports to suppress before returning an error message to the user. Error reports are cached and therefore automatically purged after 24 hours. A successful bridge request does **not** clear the error count as sporadic issues can be the result of actual problems on the server. The implementation currently makes no assumption on the type of error, which means it also suppresses bridge errors in debug mode. The default value is, however, set to 1 which means all errors are reported. References #994
2019-10-31 20:49:45 +03:00
; Defines how often an error must occur before it is reported to the user
report_limit = 1
caches: Refactor the API (#1060) - For consistency, functions should always return null on non-existing data. - WordPressPluginUpdateBridge appears to have used its own cache instance in the past. Obviously not used anymore. - Since $key can be anything, the cache implementation must ensure to assign the related data reliably; most commonly by serializing and hashing the key in an appropriate way. - Even though the default path for storage is perfectly fine, some people may want to use a different location. This is an example how a cache implementation is responsible for its requirements.
2019-04-29 21:12:43 +03:00
; --- Cache specific configuration ---------------------------------------------
feat: add filecache config to enable/disable real purge (#3263) * refactor: cachefactory * feat: add filecache config to enable/disable real purge * test: fix test
2023-03-06 23:50:40 +03:00
[FileCache]
feat: add config option "path" for file cache (#3297)
2023-03-20 21:10:01 +03:00
; The root folder to store files in.
; "" = Use the cache folder in the repository (default)
path = ""
feat: add filecache config to enable/disable real purge (#3263) * refactor: cachefactory * feat: add filecache config to enable/disable real purge * test: fix test
2023-03-06 23:50:40 +03:00
; Whether to actually delete files when purging. Can be useful to turn off to increase performance.
enable_purge = true
caches: Refactor the API (#1060) - For consistency, functions should always return null on non-existing data. - WordPressPluginUpdateBridge appears to have used its own cache instance in the past. Obviously not used anymore. - Since $key can be anything, the cache implementation must ensure to assign the related data reliably; most commonly by serializing and hashing the key in an appropriate way. - Even though the default path for storage is perfectly fine, some people may want to use a different location. This is an example how a cache implementation is responsible for its requirements.
2019-04-29 21:12:43 +03:00
[SQLiteCache]
feat(sqlite cache): add config options (#3499) * refactor: sqlite cache * refactor * feat: add config options to sqlite cache * refactor
2023-07-06 16:59:38 +03:00
; Filepath of the sqlite db file
caches: Refactor the API (#1060) - For consistency, functions should always return null on non-existing data. - WordPressPluginUpdateBridge appears to have used its own cache instance in the past. Obviously not used anymore. - Since $key can be anything, the cache implementation must ensure to assign the related data reliably; most commonly by serializing and hashing the key in an appropriate way. - Even though the default path for storage is perfectly fine, some people may want to use a different location. This is an example how a cache implementation is responsible for its requirements.
2019-04-29 21:12:43 +03:00
file = "cache.sqlite"
feat(sqlite cache): add config options (#3499) * refactor: sqlite cache * refactor * feat: add config options to sqlite cache * refactor
2023-07-06 16:59:38 +03:00
; Whether to actually delete data when purging
enable_purge = true
; Busy wait in ms before timing out
timeout = 5000
[core] Implemented MemcachedCache (#1000) * [core] Implemented MemcachedCache
2019-05-03 12:56:07 +03:00
[MemcachedCache]
host = "localhost"
port = 11211
[DiscogsBridge] Add optional image, if personal access token is configured (#3083)
2022-11-03 22:33:43 +03:00
; --- Bridge specific configuration ------
[DiscogsBridge]
; Sets the personal access token for interactions with Discogs. When
; provided, images can be included in generated feeds.
;
; "" = no token used (default)
personal_access_token = ""
Reference in a new issue Copy permalink