plnt

README

Overview

plnt is an RSS feed aggregator.

plnt is configured via a TOML file (located at /etc/plnt.toml by default) and spits out an HTML and ATOM feed.

Caching

A representation of each feed is persisted to the cache directory whenever the feed is accessed. Subsequent requests set the If-Modified-Since HTTP header and will load the feed from cache if it has not changed on the server, or if the server is unreachable (so that brief unavailability will not cause spurious changes in the output).

For quick development cycles, you can use the -force_from_cache command line flag to skip any network access.

It is safe to delete files (individually or all at once) from the cache directory to force an update.

Documentation

Index

• type Aggregator
  • func (a *Aggregator) Fetch(ctx context.Context) ([]*Feed, []Item, error)
• type Feed
• type FeedConfig
• type Item

Types

type Aggregator

type Aggregator struct {
	Feeds []FeedConfig

	ForceFromCache bool // force loading all files from cache for rapid development
}

func (*Aggregator) Fetch

func (a *Aggregator) Fetch(ctx context.Context) ([]*Feed, []Item, error)

type Feed

type Feed struct {
	Title string
	Link  string
	Items []Item
}

type FeedConfig

type FeedConfig struct {
	ShortName string // used in the state directory name, e.g. “sur5r-blog”
	Title     string `toml:"title"` // human-readable, e.g. “sur5r’s Hardware Blog”
	URL       string `toml:"url"`
}

type Item

type Item struct {
	gofeed.Item

	FeedTitle string
	FeedLink  string
}