mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2025-04-04 16:49:35 +00:00
283 lines
19 KiB
HTML
283 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<title>Custom Configuration - RSS-Bridge</title>
|
||
<meta name="description" content="The RSS feed for websites missing it">
|
||
<meta name="author" content="RSS-Bridge Contributors">
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
||
<link rel="icon" href="../themes/daux/img/favicon-blue.png" type="image/x-icon">
|
||
|
||
<!-- Mobile -->
|
||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<!-- JS -->
|
||
<script>
|
||
window.base_url = "../";
|
||
document.documentElement.classList.remove('no-js');
|
||
</script>
|
||
|
||
<!-- Font -->
|
||
|
||
<!-- CSS -->
|
||
<link href='../themes/daux/css/theme-blue.min.css' rel='stylesheet' type='text/css'>
|
||
<link href='../daux_libraries/search.css' rel='stylesheet' type='text/css'>
|
||
</head>
|
||
<body class="">
|
||
<div class="Columns content">
|
||
<aside class="Columns__left Collapsible">
|
||
<button type="button" class="Button Collapsible__trigger" aria-controls="sidebar_content" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
</button>
|
||
|
||
<a class="Brand" href="../index.html">RSS-Bridge</a>
|
||
|
||
<form role='search' action="/" method="get" class="Search" id="search_form">
|
||
<label for="search_input">
|
||
<span class='u-visuallyHidden'>Search</span>
|
||
</label>
|
||
<input
|
||
type="search"
|
||
id="search_input"
|
||
class="Search__field"
|
||
placeholder="Search..."
|
||
aria-label="Search..."
|
||
autocomplete="on"
|
||
results=25
|
||
autosave=text_search
|
||
>
|
||
<label>
|
||
<input type="submit" class='u-visuallyHidden' />
|
||
<span class='u-visuallyHidden'>Search...</span>
|
||
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
|
||
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
|
||
</svg>
|
||
</label>
|
||
</form>
|
||
|
||
<div class="Collapsible__content" id="sidebar_content">
|
||
<!-- Navigation -->
|
||
<ul class='Nav'><li class='Nav__item has-children'><a href="../General/Project_goals.html" class="Nav__item__link"><i class="Nav__arrow"> </i>General</a><ul class='Nav'><li class='Nav__item '><a href="../General/Project_goals.html">Project-goals</a></li><li class='Nav__item '><a href="../General/Contribute.html">Contribute</a></li><li class='Nav__item '><a href="../General/Requirements.html">Requirements</a></li><li class='Nav__item '><a href="../General/Screenshots.html">Screenshots</a></li><li class='Nav__item '><a href="../General/FAQ.html">FAQ</a></li><li class='Nav__item '><a href="../General/Public_Hosts.html">Public Hosts</a></li></ul></li><li class='Nav__item '><a href="../CLI/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>CLI</a><ul class='Nav'></ul></li><li class='Nav__item Nav__item--open has-children'><a href="../For_Hosts/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>For Hosts</a><ul class='Nav'><li class='Nav__item '><a href="../For_Hosts/Installation.html">Installation</a></li><li class='Nav__item '><a href="../For_Hosts/Updating.html">Updating</a></li><li class='Nav__item '><a href="../For_Hosts/Heroku_Installation.html">Heroku Installation</a></li><li class='Nav__item '><a href="../For_Hosts/Whitelisting.html">Whitelisting</a></li><li class='Nav__item '><a href="../For_Hosts/Authentication.html">Authentication</a></li><li class='Nav__item '><a href="../For_Hosts/Customizations.html">Customizations</a></li><li class='Nav__item Nav__item--active'><a href="../For_Hosts/Custom_Configuration.html">Custom Configuration</a></li></ul></li><li class='Nav__item has-children'><a href="../For_Developers/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>For Developers</a><ul class='Nav'><li class='Nav__item '><a href="../For_Developers/Coding_style_policy.html">Coding style policy</a></li><li class='Nav__item '><a href="../For_Developers/Pull_Request_policy.html">Pull Request policy</a></li><li class='Nav__item '><a href="../For_Developers/Folder_structure.html">Folder structure</a></li><li class='Nav__item '><a href="../For_Developers/Actions.html">Actions</a></li><li class='Nav__item '><a href="../For_Developers/Debug_mode.html">Debug mode</a></li><li class='Nav__item '><a href="../For_Developers/Github_Codespaces_Tutorial.html">Github Codespaces Tutorial</a></li><li class='Nav__item '><a href="../For_Developers/Development_Environment_Setup.html">Development Environment Setup</a></li></ul></li><li class='Nav__item has-children'><a href="../Bridge_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Bridge API</a><ul class='Nav'><li class='Nav__item '><a href="../Bridge_API/How_to_create_a_new_bridge.html">How to create a new bridge</a></li><li class='Nav__item '><a href="../Bridge_API/BridgeAbstract.html">BridgeAbstract</a></li><li class='Nav__item '><a href="../Bridge_API/FeedExpander.html">FeedExpander</a></li><li class='Nav__item '><a href="../Bridge_API/WebDriverAbstract.html">WebDriverAbstract</a></li><li class='Nav__item '><a href="../Bridge_API/XPathAbstract.html">XPathAbstract</a></li></ul></li><li class='Nav__item '><a href="../Helper_functions/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Helper functions</a><ul class='Nav'></ul></li><li class='Nav__item has-children'><a href="../Cache_API/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Cache API</a><ul class='Nav'><li class='Nav__item '><a href="../Cache_API/How_to_create_a_new_cache.html">How to create a new cache</a></li><li class='Nav__item '><a href="../Cache_API/CacheInterface.html">CacheInterface</a></li></ul></li><li class='Nav__item '><a href="../Technical_recommendations/index.html" class="Nav__item__link"><i class="Nav__arrow"> </i>Technical recommendations</a><ul class='Nav'></ul></li><li class='Nav__item has-children'><a href="../Bridge_Specific/ActivityPub_(Mastodon).html" class="Nav__item__link"><i class="Nav__arrow"> </i>Bridge Specific</a><ul class='Nav'><li class='Nav__item '><a href="../Bridge_Specific/ActivityPub_(Mastodon).html">ActivityPub (Mastodon)</a></li><li class='Nav__item '><a href="../Bridge_Specific/Economist.html">Economist</a></li><li class='Nav__item '><a href="../Bridge_Specific/FacebookBridge.html">FacebookBridge</a></li><li class='Nav__item '><a href="../Bridge_Specific/FurAffinityBridge.html">FurAffinityBridge</a></li><li class='Nav__item '><a href="../Bridge_Specific/Furaffinityuser.html">Furaffinityuser</a></li><li class='Nav__item '><a href="../Bridge_Specific/Instagram.html">Instagram</a></li><li class='Nav__item '><a href="../Bridge_Specific/PixivBridge.html">PixivBridge</a></li><li class='Nav__item '><a href="../Bridge_Specific/Substack.html">Substack</a></li><li class='Nav__item '><a href="../Bridge_Specific/Telegram.html">Telegram</a></li><li class='Nav__item '><a href="../Bridge_Specific/TwitterV2.html">TwitterV2</a></li><li class='Nav__item '><a href="../Bridge_Specific/Vk2.html">Vk2</a></li></ul></li></ul>
|
||
<div class="Links">
|
||
<hr/>
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge" target="_blank" rel="noopener noreferrer">GitHub Repository</a>
|
||
<br />
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge/issues" target="_blank" rel="noopener noreferrer">Help/Support/Bugs</a>
|
||
<br />
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge/pkgs/container/rss-bridge" target="_blank" rel="noopener noreferrer">Docker Images</a>
|
||
<br />
|
||
</div>
|
||
|
||
<div class="CodeToggler">
|
||
<hr/>
|
||
<label class="Checkbox">Show Code Blocks <input type="checkbox" class="CodeToggler__button--main" checked="checked"/>
|
||
<div class="Checkbox__indicator"></div>
|
||
</label>
|
||
</div>
|
||
|
||
<div class="DarkModeToggler">
|
||
<hr/>
|
||
<label class="Checkbox">Dark Mode <input type="checkbox" class="ColorMode__button" />
|
||
<div class="Checkbox__indicator"></div>
|
||
</label>
|
||
</div>
|
||
|
||
|
||
<div class="PoweredBy">
|
||
<hr/>
|
||
Powered by Daux.io </div>
|
||
</div>
|
||
</aside>
|
||
<div class="Columns__right">
|
||
<div class="Columns__right__content">
|
||
<div class="doc_content">
|
||
<article class="Page">
|
||
|
||
<div class="Page__header">
|
||
<h1><a href="../For_Hosts/index.html">For Hosts</a> <svg class="Page__header--separator" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 477.175 477.175"><path d="M360.73 229.075l-225.1-225.1c-5.3-5.3-13.8-5.3-19.1 0s-5.3 13.8 0 19.1l215.5 215.5-215.5 215.5c-5.3 5.3-5.3 13.8 0 19.1 2.6 2.6 6.1 4 9.5 4 3.4 0 6.9-1.3 9.5-4l225.1-225.1c5.3-5.2 5.3-13.8.1-19z"/></svg> <a href="../For_Hosts/Custom_Configuration.html">Custom Configuration</a></h1>
|
||
<span class="ModifiedDate">
|
||
March 24, 2025 at 1:12 PM </span>
|
||
<span class="EditOn">
|
||
<a href="https://github.com/RSS-Bridge/rss-bridge/tree/master/docs/03_For_Hosts/08_Custom_Configuration.md" target="_blank">
|
||
Edit on GitHub </a>
|
||
</span>
|
||
</div>
|
||
|
||
<div class="s-content">
|
||
<p>RSS-Bridge supports custom configurations for common parameters on the server side!</p>
|
||
<p>A default configuration file (<code>config.default.ini.php</code>) is shipped with RSS-Bridge.
|
||
Please do not edit this file, as it gets replaced when upgrading RSS-Bridge!</p>
|
||
<p>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:</p>
|
||
<ul>
|
||
<li>Create the file <code>config.ini.php</code> in the RSS-Bridge root folder (next to <code>config.default.ini.php</code>)</li>
|
||
<li>Copy the contents from <code>config.default.ini.php</code> to your configuration file</li>
|
||
<li>Change the parameters to satisfy your requirements</li>
|
||
</ul>
|
||
<p>RSS-Bridge will automatically detect the <code>config.ini.php</code> and use it.
|
||
If the file doesn’t exist it will default to <code>config.default.ini.php</code> automatically.</p>
|
||
<p><strong>Notice</strong>: If a parameter is not specified in your <code>config.ini.php</code> RSS-Bridge will
|
||
automatically use the default settings from <code>config.default.ini.php</code>.</p>
|
||
<h1><a id="available-parameters" href="#available-parameters" class="Permalink" aria-hidden="true" title="Permalink">#</a>Available parameters</h1>
|
||
<p>The configuration file is split into sections:</p>
|
||
<ul>
|
||
<li><a href="#system">system</a></li>
|
||
<li><a href="#http-client">http client</a></li>
|
||
<li><a href="#cache">cache</a></li>
|
||
<li><a href="#proxy">proxy</a></li>
|
||
<li><a href="#authentication">authentication</a></li>
|
||
<li><a href="#admin">admin</a></li>
|
||
<li><a href="#error">error</a></li>
|
||
</ul>
|
||
<p><em>System</em>: This section specifies system specific parameters</p>
|
||
<p><em>Http client</em>: This section has http client options</p>
|
||
<p><em>Cache</em>: This section is all about the caching behavior of RSS-Bridge</p>
|
||
<p><em>Proxy</em>: This section can be used to specify a proxy server for RSS-Bridge to utilize for fetching contents</p>
|
||
<p><em>Authentication</em>: This section defines parameters to require authentication to use RSS-Bridge</p>
|
||
<p><em>Admin</em>: This section specifies parameters related to the administrator of your instance of RSS-Bridge</p>
|
||
<h2><a id="system" href="#system" class="Permalink" aria-hidden="true" title="Permalink">#</a>System</h2>
|
||
<p>This section provides following parameters:</p>
|
||
<ul>
|
||
<li><a href="#timezone">timezone</a></li>
|
||
</ul>
|
||
<h3><a id="timezone" href="#timezone" class="Permalink" aria-hidden="true" title="Permalink">#</a>Timezone</h3>
|
||
<p>Defines the timezone used by RSS-Bridge. This parameter can be set to any value of the values defined at <a href="https://www.php.net/manual/en/timezones.php" class="Link--external" rel="noopener noreferrer">https://www.php.net/manual/en/timezones.php</a></p>
|
||
<p>The default value is <code>UTC</code>.</p>
|
||
<h2><a id="cache" href="#cache" class="Permalink" aria-hidden="true" title="Permalink">#</a>Cache</h2>
|
||
<p>This section provides following parameters:</p>
|
||
<ul>
|
||
<li><a href="#type">type</a></li>
|
||
<li><a href="#custom_timeout">custom_timeout</a></li>
|
||
</ul>
|
||
<h3><a id="type" href="#type" class="Permalink" aria-hidden="true" title="Permalink">#</a>type</h3>
|
||
<p>Defines the cache type used by RSS-Bridge.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>file</code></td>
|
||
<td>File based (default)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>sqlite</code></td>
|
||
<td>SQLite database</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>memcached</code></td>
|
||
<td>Memcached service</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3><a id="custom-timeout" href="#custom-timeout" class="Permalink" aria-hidden="true" title="Permalink">#</a>custom_timeout</h3>
|
||
<p>Allow users to specify custom timeout for specific requests.</p>
|
||
<p><code>true</code> = enabled</p>
|
||
<p><code>false</code> = disabled (default)</p>
|
||
<h2><a id="proxy" href="#proxy" class="Permalink" aria-hidden="true" title="Permalink">#</a>Proxy</h2>
|
||
<p>This section provides following parameters:</p>
|
||
<ul>
|
||
<li><a href="#url">url</a></li>
|
||
<li><a href="#name">name</a></li>
|
||
<li><a href="#by_bridge">by_bridge</a></li>
|
||
</ul>
|
||
<h3><a id="url" href="#url" class="Permalink" aria-hidden="true" title="Permalink">#</a>url</h3>
|
||
<p>Sets the proxy url (i.e. “tcp://192.168.0.0:32”)</p>
|
||
<p><code>""</code> = Proxy disabled (default)</p>
|
||
<h3><a id="name" href="#name" class="Permalink" aria-hidden="true" title="Permalink">#</a>name</h3>
|
||
<p>Sets the proxy name that is shown on the bridge instead of the proxy url.</p>
|
||
<p><code>""</code> = Show proxy url (default: “Hidden proxy name”)</p>
|
||
<h3><a id="by-bridge" href="#by-bridge" class="Permalink" aria-hidden="true" title="Permalink">#</a>by_bridge</h3>
|
||
<p>Allow users to disable proxy usage for specific requests.</p>
|
||
<p><code>true</code> = enabled</p>
|
||
<p><code>false</code> = disabled (default)</p>
|
||
<h2><a id="http-client" href="#http-client" class="Permalink" aria-hidden="true" title="Permalink">#</a>Http client</h2>
|
||
<p>This section provides the following parameters:</p>
|
||
<ul>
|
||
<li>timeout</li>
|
||
<li>useragent</li>
|
||
</ul>
|
||
<h3><a id="timeout" href="#timeout" class="Permalink" aria-hidden="true" title="Permalink">#</a>timeout</h3>
|
||
<p>Default network timeout.</p>
|
||
<h3><a id="useragent" href="#useragent" class="Permalink" aria-hidden="true" title="Permalink">#</a>useragent</h3>
|
||
<p>Default user agent.</p>
|
||
<h2><a id="authentication" href="#authentication" class="Permalink" aria-hidden="true" title="Permalink">#</a>Authentication</h2>
|
||
<p>This section provides following parameters:</p>
|
||
<ul>
|
||
<li><a href="#enable">enable</a></li>
|
||
<li><a href="#username">username</a></li>
|
||
<li><a href="#password">password</a></li>
|
||
</ul>
|
||
<h3><a id="enable" href="#enable" class="Permalink" aria-hidden="true" title="Permalink">#</a>enable</h3>
|
||
<p>Enables authentication for RSS-Bridge.</p>
|
||
<p><em>Notice</em>: Login is required for all requests when enabled! Make sure to update feed subscriptions accordingly.</p>
|
||
<p><code>true</code> = enabled</p>
|
||
<p><code>false</code> = disabled (default)</p>
|
||
<h3><a id="username" href="#username" class="Permalink" aria-hidden="true" title="Permalink">#</a>username</h3>
|
||
<p>Defines the user name used for login.</p>
|
||
<h3><a id="password" href="#password" class="Permalink" aria-hidden="true" title="Permalink">#</a>password</h3>
|
||
<p>Defines the password used for login. Use a strong password to prevent others from guessing your login!</p>
|
||
<h2><a id="admin" href="#admin" class="Permalink" aria-hidden="true" title="Permalink">#</a>Admin</h2>
|
||
<p>This section provides following parameters:</p>
|
||
<ul>
|
||
<li><a href="#email">email</a></li>
|
||
</ul>
|
||
<h3><a id="email" href="#email" class="Permalink" aria-hidden="true" title="Permalink">#</a>email</h3>
|
||
<p>Advertises an email address where people can reach the administrator.</p>
|
||
<p><em>Notice</em>: This address is displayed on the main page, visible to everyone!</p>
|
||
<p><code>""</code> = Disabled (default)</p>
|
||
<p>Example: <code>email = "admin@instance.rss-bridge.com"</code></p>
|
||
<h2><a id="error" href="#error" class="Permalink" aria-hidden="true" title="Permalink">#</a>error</h2>
|
||
<p>This section provides following parameters:</p>
|
||
<ul>
|
||
<li><a href="#output">output</a></li>
|
||
<li><a href="#report_limit">report_limit</a></li>
|
||
</ul>
|
||
<h3><a id="output" href="#output" class="Permalink" aria-hidden="true" title="Permalink">#</a>output</h3>
|
||
<p>Defines how error messages are returned by RSS-Bridge</p>
|
||
<p><code>feed</code>: As part of the feed (default)</p>
|
||
<p><code>http</code>: As HTTP error message</p>
|
||
<p><code>none</code>: No errors are reported</p>
|
||
<h3><a id="report-limit" href="#report-limit" class="Permalink" aria-hidden="true" title="Permalink">#</a>report_limit</h3>
|
||
<p>Defines how often an error must occur before it is reported to the user</p>
|
||
<p><code>report_limit</code>: 1 (default)</p>
|
||
</div>
|
||
|
||
<nav>
|
||
<ul class="Pager">
|
||
<li class=Pager--prev><a href="../For_Hosts/Customizations.html">Previous</a></li> <li class=Pager--next><a href="../For_Developers/index.html">Next</a></li> </ul>
|
||
</nav>
|
||
</article>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<!-- JS -->
|
||
<script src="../themes/daux/js/daux.min.js"></script>
|
||
|
||
<script>
|
||
|
||
window.searchLanguage = "";
|
||
window.searchTranslation = {"Search_one_result":"1 result","Search_results":"!count results","Search_no_results":"Nothing found","Search_common_words_ignored":"Common words are largely ignored","Search_too_short":"Search too short","Search_one_character_or_more":"Should be one character or more","Search_should_be_x_or_more":"Should be !min characters or more","Link_previous":"Previous","Link_next":"Next"};
|
||
</script>
|
||
|
||
<!-- Search -->
|
||
<script type="text/javascript" src="../daux_libraries/search.min.js"></script>
|
||
|
||
<script>
|
||
window.search({'base_url': '../'})
|
||
</script>
|
||
</body>
|
||
</html>
|