brrss

README

BrRSS

HTML-to-RSS bridge that can be used as a serverless function or run as a server.

Getting started

Container

1. Pull and run registry.gitlab.com/buzzer13/brrss:latest image (tag can be either latest, or a specific version like v1.0.0).
   • Command: docker run --name=brrss -it "registry.gitlab.com/buzzer13/brrss:latest"
   • Server doesn't enable an authentication by default, so you may want to check configuration section.

Configuration

Environment variables

• API_KEY - when set - enables key auth for the API and requires api-key parameter to be present in every query.
• API_USERNAME, API_PASSWORD - when both are set - enables basic auth for the API.

Both API_KEY and API_PASSWORD can be either the plain string or bcrypt-compatible hash.

Documentation

Index

• func HTMLToFeed(body io.Reader, feedFormat FeedFormat, options HTMLToFeedOptions) (string, error)
• func SelectText(item *goquery.Selection, selKind SelKind, selCustom string, ...) (string, error)
• func TryParseTime(layout string, value string) time.Time
• func TrySelectText(item *goquery.Selection, selKind SelKind, selCustom string, ...) string
• type FeedFormat
• type HTMLToFeedOptions
• type SelKind
• type SelectTextOptions

Functions

func HTMLToFeed

func HTMLToFeed(body io.Reader, feedFormat FeedFormat, options HTMLToFeedOptions) (string, error)

func SelectText

func SelectText(item *goquery.Selection, selKind SelKind, selCustom string, options *SelectTextOptions) (string, error)

func TryParseTime

func TryParseTime(layout string, value string) time.Time

func TrySelectText

func TrySelectText(item *goquery.Selection, selKind SelKind, selCustom string, options *SelectTextOptions) string

Types

type FeedFormat

type FeedFormat string

const (
	AtomFeedFormat FeedFormat = "atom"
	JSONFeedFormat FeedFormat = "json"
	RSSFeedFormat  FeedFormat = "rss"
)

type HTMLToFeedOptions

type HTMLToFeedOptions struct {
	BaseURL      url.URL
	SelItem      string
	SelFeedTitle string
	SelFeedDesc  string
	SelItemTime  string
	SelItemDesc  string
	SelItemLink  string
	SelItemTitle string
}

type SelKind

type SelKind int64

const (
	FeedTitleSelKind SelKind = iota
	FeedDescSelKind
	ItemTitleSelKind
	ItemLinkSelKind
	ItemDescSelKind
	ItemTimeSelKind
)

type SelectTextOptions

type SelectTextOptions struct {
	BaseURL url.URL
}