rss_widget

Created 8 months ago
Maintained by glb
Serves RSS feeds for display in Element's Custom Widget integration
Members 1
Gregory Bartholomew committed 8 months ago

rss_widget is a container designed to function as a backend for the the "Custom Widget" Element integration. It needs to be run behind a reverse proxy for SSL. An example proxy configurate for Apache's httpd is provided below.

Synopsis

$ cd rss_widget
$ podman build -t rss_widget_image .
$ podman run -d -p 3000:3000 --name rss_widget_container rss_widget_image

Example Apache HTTP Server configuration snippet

<Location "/_widget0">
   ProxyPass http://my-container-server.example.com:3000/
   ProxyPassReverse http://my-container-server.example.com:3000/

   Require ssl
</Location>

Element configuration

Assuming you've chosen to proxy the /_widget0 path as shown above and the hostname of your proxy server is my-proxy-server.example.com, the URL that you would enter in Element's Custom Widget integration would be https://my-proxy-server.example.com/_widget0/?u=<your-rss-feed-url>. Optionally, you can append &c=<n> where <n> is a positive integer to set the number of RSS titles to display in the widget. You can also append &f=<m> where <m> is a positive integer representing the refresh frequency in minutes.

License

rss_widget is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See the Perl 5 License for details.

Disclaimer

This package is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.