feedhook

module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2024 License: MIT

README

feedhook

A service for forwarding RSS and Atom feeds to Discord webhooks.

GitHub Release CI/CD GitHub License

Key Features

  • Forward RSS and Atom feeds to webhooks on Discord
  • Respects Discord rate limits
  • Build for high throughput
  • Easy configuration
  • Single executable file
  • Restartable without data loss
  • Live statistics

Example

Here is how a forwarded RSS item looks on Discord:

example

Installation (WIP)

This section explains how to install feedhook as a service on a Unix-like server.

[!NOTE] This guide uses supervisor for running feedhook as service. Please install it first.

Create a "service" user with disabled login:

sudo adduser --disabled-login feedhook

Switch to the new user and move to the home directory:

sudo su feedhook
cd ~

Download and decompress executable:

wget https://github.com/ErikKalkoken/feedhook/releases/download/v0.1.16/feedhook-0.1.16-linux-amd64.tar.gz
tar -xvzf feedhook-0.1.16-linux-amd64.tar.gz

[!TIP] Please make sure update the URL and filename to the latest version.

Download configuration files:

wget https://raw.githubusercontent.com/ErikKalkoken/feedhook/main/config/supervisor.conf
wget https://raw.githubusercontent.com/ErikKalkoken/feedhook/main/config/config.toml

Setup and configure:

chmod +x feedhook
touch feedhook.log

Setup feeds and webhooks by adding them to config.toml.

Add feedhook to supervisor:

sudo ln -s /home/feedhook/supervisor.conf /etc/supervisor/conf.d/feedhook.conf
sudo systemctl restart supervisor

Restart feedhook to start feedhook.

sudo supervisorctl restart feedhook

Attributions

Directories

Path Synopsis
cmd
internal
app
app/dispatcher
Package dispatcher contains the dispatcher service.
Package dispatcher contains the dispatcher service.
app/remote
Package remoteservice contains the logic for communicating between cli and server process
Package remoteservice contains the logic for communicating between cli and server process
dhooks
Package dhooks provides types and functions for sending messages to Discord webhooks.
Package dhooks provides types and functions for sending messages to Discord webhooks.
queue
Package queue contains a persistent queue.
Package queue contains a persistent queue.
rate
Package rate provides types for dealing with rate limits.
Package rate provides types for dealing with rate limits.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL