https://github.com/buzzer13/brrss

RSS Bridge
https://github.com/buzzer13/brrss

golang rss rss-generator

Last synced: about 9 hours ago
JSON representation

RSS Bridge

• Host: GitHub
• URL: https://github.com/buzzer13/brrss
• Owner: buzzer13
• License: mit
• Created: 2024-10-29T02:45:37.000Z (18 days ago)
• Default Branch: main
• Last Pushed: 2024-11-11T21:03:05.000Z (4 days ago)
• Last Synced: 2024-11-11T22:18:24.906Z (4 days ago)
• Topics: golang, rss, rss-generator
• Language: Go
• Homepage:
• Size: 68.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license.txt

Awesome Lists containing this project

README

        
# BrRSS

[![latest release](https://img.shields.io/github/v/release/buzzer13/brrss)](https://github.com/buzzer13/brrss/releases)

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

# Getting started

[//]: # (## Releases)

[//]: # ()

[//]: # (1. Download a binary for your OS from the [GitHub releases](https://github.com/buzzer13/brrss/releases) page.)

[//]: # (2. Prepare a [configuration file](#configuration) and put it in the supported directory.)

## Container

1. Pull and run `ghcr.io/buzzer13/brrss:latest` image (tag can be either `latest`, or a specific version like `v1.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](#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.