rsslater

README

RSSLater

Turn your "I want to read this later" items into an RSS feed!

Installation

Assuming you have Go installed, run this:

go install -v code.nkcmr.net/rsslater@latest

Getting Started

First, let's get it running.

Running

Once installed, running is designed to be as simple as possible without much configuration:

rsslater --origin https://myrsslater-service.example.com --auto-cert

The --auto-cert option will try to use LetsEncrypt to get TLS setup for your server, but it requires the origin to be publicly reachable.

There are enough other options to get the origin to actually be reachable by some other means; a few other options are below.

Login Setup

Once the server is running, you'll need to initialize the login by adding a Webauthn Security Key (YubiKey, iPhone, Android, etc...). This is why HTTPS is required since Webauthn only works on secure pages.

Extension

Once the server is able to identify you, it will allow you to install an extension and connect the extension to your server.

The extension isn't published to any public extension store as of this writing. I am currently just using it as an unpacked extension at the moment.

Feed URL

Next to the extension section, there will also be a private RSS feed URL. This will be how the items actually get into your RSS reader.

Ideas for reachability

Opening the server directly to the Internet is an option, but here are some other ideas:

Cloudflare Tunnels: Easy/free/secure

Cloudflare Tunnels allows your service to be reachable on the Internet without fiddling with firewalls or networking stuff too much.

cloudflared (the program that actually establishes the tunnels) does have a quick setup mode that doesn't require an account or anything (cloudflared tunnel --url <...>), but the trouble with that for this application is that we need to know the origin URL ahead of time for Webauthn.

So! Using it does require an account (which is free), and a domain name (not so free, but purchasable with Cloudflare!).

With that in mind here are the steps:

1. Sign up for an account and add/register/transfer a domain name to your Cloudflare account.

2. Install cloudflared: https://github.com/cloudflare/cloudflared#installing-cloudflared

3. Login to cloudflared: cloudflared tunnel login

4. Get the RSSLater server running at a subdomain of your domain:

   rsslater --origin https://myrsslater.example.com --listen 127.0.0.1:8081
   

5. Start the tunnel and hook it up to your RSSLater service:

   cloudflared tunnel --name myrsslater.example.com --url http://127.0.0.1:8081
   

6. Done!

License

MIT License

Copyright (c) 2022 Nicholas Comer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.