innbundet

README

innbundet

Personal RSS reader, inspired by reedi.

Requirements

• Go

Usage

Build the application:

go build .

Migrate the database models (this only needs to be done once):

innbundet migrate

Add the --include-example-data flag to include some RSS feeds:

innbundet migrate --include-example-data

Then you'll want to run the sync command to fetch any new feed items. This should be done periodically:

innbundet sync

Run the web app using the server command:

innbundet server

This will serve the application on http://localhost:8080

You can override the port by using the PORT environment variable:

PORT=5050 innbundet server

All the commands will attempt to read the config from a config file, which is assumed to be config.yaml but can also be set using the --config parameter:

innbundet sync --config my_config.yaml

All the commands also accept the --debug flag which will show debug output:

innbundet sync --debug

Config File

The configuration file is a YAML and can contain the following:

database_file: innbundet.sqlite  # Path to the SQLite database file
description: Tiny RSS reader.    # Description of the page
items_per_page: 25               # Amount of items to show per page
title: Innbundet                 # Title of the page

If no file is present it will use all the defaults.

Adding Feeds

You can add the feeds using the add subcommand. Just provide it with the URL of the feed:

innbundet add https://michaelenger.com/feed.rss

You can also provide a web URL and it will look for a feed in the site's <link> tags:

innbundet add https://michaelenger.com/

Removing Feeds

You can remove a feed using the remove subcommand and the feed's ID:

innbundet remove 123

Exporting Feeds

The export command will list all feeds as JSON which can be piped to a file if need be:

innbundet export > feeds.json

TODO

Things that may be fun to add:

• Bookmarking feed items to keep them for reading later
• Managing feeds via the frontend
• Hide feeds from the main feed list (for feeds that have lots of items)
• Add tags to feeds so you can see a limited frontpage
• Expose sync errors to the frontend somehow