# README
BrRSS
RSS bridge that can be used as a serverless function or run as a server.
Getting started
Container
- Pull and run
ghcr.io/buzzer13/brrss:latest
image (tag can be eitherlatest
, or a specific version likev1.4.0
).- Command:
docker run --name=brrss -it "ghcr.io/buzzer13/brrss:latest"
- Server doesn't enable an authentication by default, so you may want to check configuration section.
- Command:
Configuration
Environment variables
API_KEY
- when set - enables key auth for the API and requiresapi-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.