diff --git a/_snippets/common-links.md b/_snippets/common-links.md index bace449..645cbb3 100644 --- a/_snippets/common-links.md +++ b/_snippets/common-links.md @@ -23,6 +23,7 @@ [portainer]: /recipes/portainer/ [radarr]: /recipes/autopirate/radarr/ [rtorrent]: /recipes/autopirate/rtorrent/ +[rss]: /recipes/rss/ [sabnzbd]: /recipes/autopirate/sabnzbd/ [sonarr]: /recipes/autopirate/sonarr/ [tfa-dex-static]: /ha-docker-swarm/traefik-forward-auth/dex-static/ diff --git a/manuscript/CHANGELOG.md b/manuscript/CHANGELOG.md index 951ed67..7458a97 100644 --- a/manuscript/CHANGELOG.md +++ b/manuscript/CHANGELOG.md @@ -8,7 +8,7 @@ hide: Recipe | Description | Date -------------------------|------------------------------------------------------------------------------------------------------------------|-------------- -[Authelia][authelia] | Authentication and two factor authorization server with Authelia | _1 Oct 2021_ +[Rss][rss] | Service that generates RSS Feeds for websites that don't have one. It can be used on webservers or as a stand-alone application in CLI mode | _1 Oct 2021_ [NightScout][nightscout] | Share your CGM :drop_of_blood: data, setup advanced alarms and charts, for improved diabetes treatment :syringe: and quality-of-life :runner: | _9 Aug 2021_ [Mealie][mealie] | Delicious, API-driven recipe manager, able to scrape-and-import recipes from a URL :cook: | _4 Feb 2021_ [Funkwhale][funkwhale] | Enjoy, share, and federate your music in your own funky "pod". Think "Mastodon for Music" :whale: :musical_note: | _28 Jan 2021_ diff --git a/manuscript/images/rss.png b/manuscript/images/rss.png new file mode 100644 index 0000000..6db77a8 Binary files /dev/null and b/manuscript/images/rss.png differ diff --git a/manuscript/recipes/rss.md b/manuscript/recipes/rss.md index 17f70d4..e4cccfc 100644 --- a/manuscript/recipes/rss.md +++ b/manuscript/recipes/rss.md @@ -1 +1,73 @@ -# RSS Bridge \ No newline at end of file +# RSS Bridge + +[RSS-Bridge](https://github.com/RSS-Bridge/rss-bridge) is a PHP project capable of generating RSS and Atom feeds for websites that don't have one. It can be used on webservers or as a stand-alone application in CLI mode. You can deploy the service in different ways. Such as installing using PHP, Or you can setup using the Docker [Image](https://hub.docker.com/r/rssbridge/rss-bridge). + +![RSS Screenshot](../images/rss.png) + + +Features include +* Ability to generate RSS feeds for sites that do not have one. +* Can be used as a webserver or used as a CLI +* Supports multiple output formats such as + * Atom + * HTML + * JSON + * Mrss + * Plaintext + +--8<-- "recipe-standard-ingredients.md" + + +## Preparation + +### Setup data locations + +First we create a directory to hold the data which RSS will serve: + +``` +mkdir /var/data/config/rss +cd /var/data/config/rss +``` + +### Setup Docker Swarm + +Create a docker swarm config file in docker-compose syntax (v3), something like this: + +--8<-- "premix-cta.md" + +```yaml +version: '3' +services: + rss: + image: rssbridge/rss-bridge:latest + volumes: + - /var/data/config/rss:/config + deploy: + labels: + # traefik common + - traefik.enable=true + - traefik.docker.network=traefik_public + + # traefikv1 + - traefik.frontend.rule=Host:rss.example.com + - traefik.port=80 + + # traefikv2 + - "traefik.http.routers.rss.rule=Host(`rss.example.com`)" + - "traefik.http.services.rss.loadbalancer.server.port=80" + networks: + - traefik_public + +networks: + traefik_public: + external: true +``` + +## Serving + +### Launch RSS! + +Launch the RSS stack by running ```docker stack deploy rss -c ``` + + +--8<-- "recipe-footer.md"