diff options
Diffstat (limited to 'docs/01_General')
| -rw-r--r-- | docs/01_General/01_Project-goals.md | 8 | ||||
| -rw-r--r-- | docs/01_General/02_Contribute.md | 9 | ||||
| -rw-r--r-- | docs/01_General/03_Requirements.md | 23 | ||||
| -rw-r--r-- | docs/01_General/04_Screenshots.md | 7 | ||||
| -rw-r--r-- | docs/01_General/05_FAQ.md | 30 | ||||
| -rw-r--r-- | docs/01_General/06_Public_Hosts.md | 20 |
6 files changed, 97 insertions, 0 deletions
diff --git a/docs/01_General/01_Project-goals.md b/docs/01_General/01_Project-goals.md new file mode 100644 index 00000000..4e20b71b --- /dev/null +++ b/docs/01_General/01_Project-goals.md @@ -0,0 +1,8 @@ +**RSS-Bridge** aims at sites that: + + - don't provide public accessible Atom or RSS feeds + - force their users to subscribe to e-mail notifications + - force their users to use their own proprietary APIs + - require their users to come back on a regular basis in order to check for new content + +**RSS-Bridge** will generate feeds based on "bridges" that are developed for any site. Those bridges will collect data and extract all necessary information which is then converted into various feed formats like Atom or RSS.
\ No newline at end of file diff --git a/docs/01_General/02_Contribute.md b/docs/01_General/02_Contribute.md new file mode 100644 index 00000000..35b578f8 --- /dev/null +++ b/docs/01_General/02_Contribute.md @@ -0,0 +1,9 @@ +There are many things you can do to contribute to **RSS-Bridge** as developer or as user without any knowledge in PHP or (web) development. Here are a few things: + +- Share **RSS-Bridge** with your friends (Twitter, Facebook, ..._you name it_...) +- Report broken bridges or bugs [here](https://github.com/RSS-Bridge/rss-bridge/issues) +- Request new features or propose ideas (via [Issues](https://github.com/RSS-Bridge/rss-bridge/issues)) +- Discuss bugs, features, ideas or [issues](https://github.com/RSS-Bridge/rss-bridge/issues) +- Add new bridges or improve the API +- Improve this documentation +- Host **RSS-Bridge**
\ No newline at end of file diff --git a/docs/01_General/03_Requirements.md b/docs/01_General/03_Requirements.md new file mode 100644 index 00000000..98b0e33f --- /dev/null +++ b/docs/01_General/03_Requirements.md @@ -0,0 +1,23 @@ +**RSS-Bridge** requires either of the following: + +## A Web server* with: + + - PHP 7.1 (or higher) + - [`openssl`](https://secure.php.net/manual/en/book.openssl.php) extension + - [`libxml`](https://secure.php.net/manual/en/book.libxml.php) extension (enabled by default, see [PHP Manual](http://php.net/manual/en/libxml.installation.php)) + - [`mbstring`](https://secure.php.net/manual/en/book.mbstring.php) extension + - [`simplexml`](https://secure.php.net/manual/en/book.simplexml.php) extension + - [`curl`](https://secure.php.net/manual/en/book.curl.php) extension + - [`json`](https://secure.php.net/manual/en/book.json.php) extension + - [`filter`](https://secure.php.net/manual/en/book.filter.php) extension + - [`sqlite3`](http://php.net/manual/en/book.sqlite3.php) extension (only when using SQLiteCache) + +Enable extensions by un-commenting the corresponding line in your PHP configuration (`php.ini`). + + +## A Linux server with: + + - Docker server configured (Any recent version should do) + - 100MB of disk space + +To setup RSS Bridge using Docker, see the [Docker Guide](../03_For_Hosts/03_Docker_Installation.md) on installing RSS Bridge.
\ No newline at end of file diff --git a/docs/01_General/04_Screenshots.md b/docs/01_General/04_Screenshots.md new file mode 100644 index 00000000..af2e76fb --- /dev/null +++ b/docs/01_General/04_Screenshots.md @@ -0,0 +1,7 @@ +## Welcome screen: + + +## rss-bridge hashtag (#rss-bridge) search on Twitter: +_in Atom format (as displayed by Firefox)_ + +
\ No newline at end of file diff --git a/docs/01_General/05_FAQ.md b/docs/01_General/05_FAQ.md new file mode 100644 index 00000000..ade746d7 --- /dev/null +++ b/docs/01_General/05_FAQ.md @@ -0,0 +1,30 @@ +This page provides a collection of frequently asked questions and their answers. Please check this page before opening a new Issue :revolving_hearts: + +* [Why doesn't my bridge show new contents?](#why-doesnt-my-bridge-show-new-contents) +* [How can I make a bridge update more frequently?](#how-can-i-make-a-bridge-update-more-frequently) +* [Firefox doesn't show feeds anymore, what can I do?](#firefox-doesnt-show-feeds-anymore-what-can-i-do) + +## Why doesn't my bridge show new contents? + +RSS-Bridge creates a cached version of your feed in order to reduce traffic and respond faster. The cached version is created on the first request and served for all subsequent requests. On every request RSS-Bridge checks if the cache timeout has elapsed. If the timeout has elapsed, it loads new contents and updates the cached version. + +_Notice_: RSS-Bridge only updates feeds if you actively request it, for example by pressing F5 in your browser or using a feed reader. + +The cache duration is bridge specific and can last anywhere between five minutes and 24 hours. You can specify a custom cache timeout for each bridge if [this option](#how-can-i-make-a-bridge-update-more-frequently) has been enabled on the server. + +## How can I make a bridge update more frequently? + +You can only do that if you are hosting the RSS-Bridge instance: +- Enable [`custom_timeout`](../03_For_Hosts/08_Custom_Configuration.md#customtimeout) +- Alternatively, change the default timeout for your bridge by modifying the `CACHE_TIMEOUT` constant in the relevant bridge file (e.g [here](https://github.com/RSS-Bridge/rss-bridge/blob/master/bridges/FilterBridge.php#L7) for the Filter Bridge). + +## Firefox doesn't show feeds anymore, what can I do? + +As of version 64, Firefox removed support for viewing Atom and RSS feeds in the browser. This results in the browser downloading the pages instead of showing contents. + +Further reading: +- https://support.mozilla.org/en-US/kb/feed-reader-replacements-firefox +- https://bugzilla.mozilla.org/show_bug.cgi?id=1477667 + +To restore the original behavior in Firefox 64 or higher you can use following Add-on which attempts to recreate the original behavior (with some sugar on top): +- https://addons.mozilla.org/en-US/firefox/addon/rsspreview/
\ No newline at end of file diff --git a/docs/01_General/06_Public_Hosts.md b/docs/01_General/06_Public_Hosts.md new file mode 100644 index 00000000..35175c93 --- /dev/null +++ b/docs/01_General/06_Public_Hosts.md @@ -0,0 +1,20 @@ +| Flag | Host | Status | Contact | Comment | +|:-----------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------| +|  |  [rss-bridge.bb8.fun](https://rss-bridge.bb8.fun) |  | [@captn3m0](https://github.com/captn3m0) | Hosted in Bengaluru, India | +|  |  [feed.eugenemolotov.ru](https://feed.eugenemolotov.ru) |  | [@em92](https://github.com/em92) | Hosted in Amsterdam, Netherlands | +|  |  [bridge.suumitsu.eu](https://bridge.suumitsu.eu/) |  | [@mitsukarenai](https://github.com/mitsukarenai) | Hosted in Paris, France | +|  |  [sebsauvage.net/rss-bridge](https://sebsauvage.net/rss-bridge/) |  | [@sebsauvage](https://github.com/sebsauvage/) | Hosted in France | +|  |  [rss-bridge.snopyta.org](https://rss-bridge.snopyta.org) |  | [@Perflyst](https://github.com/Perflyst) | Hosted in Helsinki, Finland | +|  |  [rss.nixnet.xyz](https://rss.nixnet.xyz/) |  | [@amolith](https://nixnet.xyz/contact) | Hosted in Wunstorf, Germany | +|  |  [myrss4fun.xyz](https://myrss4fun.xyz) | | [@mrcoding](https://github.com/mrcoding/) | Latest GitHub Release | +|  |  [bridge.easter.fr](https://bridge.easter.fr/) |  | [@chatainsim](https://github.com/chatainsim) | Hosted in Roubaix, France | +|  |  [wtf.roflcopter.fr/rss-bridge](https://wtf.roflcopter.fr/rss-bridge/) |  | [roflcopter.fr](https://wtf.roflcopter.fr/) | Hosted in France | +|  |  [rssbridge.fossdaily.xyz](https://rssbridge.fossdaily.xyz) |  | | Hosted in Vilnius, Lithuania | +|  | https://rss-bridge.ggc-project.de |  | [@ggc-project.de](https://social.dev-wiki.de/@ggc_project) | Hosted in Steyr, Austria | +|  | https://bridge.noisebridge.info |  | [Discuss Forum](https://discuss.noisebridge.info) | Hosted in United States | +|  |  [feeds.proxeuse.com](https://feeds.proxeuse.com/) |  | [Proxeuse](https://www.proxeuse.com/en/contact-us) | Hosted in Germany | +|  |  [ololbu.ru/rss-bridge/](https://ololbu.ru/rss-bridge) |  | [@Ololbu](https://github.com/Ololbu) | Hosted in Moscow, Russia | +|  |  [tools.bheil.net/rss-bridge/](https://tools.bheil.net/rss-bridge/) |  | [@bheil](https://www.bheil.net) | Hosted in Germany | +|  |  [rss-bridge.mediani.de](https://rss-bridge.mediani.de/) |  | [@sokai](https://github.com/sokai) | Hosted with Netcup, Germany | +|  |  [rssbridge.boldair.dev](https://rssbridge.boldair.dev/) |  | [@Boldairdev](https://github.com/Boldairdev) | Latest Github release, Hosted on PHP 8.0 in Roubaix, France | +|  |  [rss-bridge.esmailelbob.xyz](https://rss-bridge.esmailelbob.xyz/) | | [@esmaiellbobdev2](https://github.com/esmailelbobve2/) | Latest GitHub Release | |