roughnecks/feed-to-muc
1
0
Fork 0
mirror of https://salsa.debian.org/mdosch/feed-to-muc.git synced 2024-12-22 12:55:23 +01:00
Code Issues Projects Releases Packages Wiki Activity
An xmpp bot which posts to a MUC if there is an update in newsfeeds.
151 commits 5 branches 0 tags 6.5 MiB
Go 100%
Find a file
Martin Dosch fe3ba3f77e Update go modules.
2024-12-07 22:02:26 +01:00
.gitignore Initial commit 2018-07-13 22:53:22 +02:00
config.json.example Added contact information and quiet mode. 2019-05-31 12:04:53 +02:00
getArticles.go [gocritic]: Improve code quality. 2024-10-05 15:20:57 +02:00
go.mod Update go modules. 2024-12-07 22:02:26 +01:00
go.sum Update go modules. 2024-12-07 22:02:26 +01:00
LICENSE Add LICENSE 2018-07-13 21:11:57 +00:00
main.go Use range for loop. 2024-11-30 10:14:48 +01:00
openConfig.go [gocritic]: Improve code quality. 2024-10-05 15:20:57 +02:00
processStanzas.go Revert "[gocritic]: Improve code quality." 2024-10-05 15:33:14 +02:00
README.md Add notice about not actively developing it further. 2023-09-29 21:23:11 +03:00
removeTracking.go Update license header and remove copyright year. 2024-04-03 07:48:47 +02:00
sendPings.go Update license header and remove copyright year. 2024-04-03 07:48:47 +02:00

README.md

feed-to-muc

about

feed-to-muc is no more actively developed. It works ok enough and I am not interested to add more features or fix corner cases where it might fail. If you're looking for an actively developed alternative you might want to have a look at Morbot.

feed-to-muc is an XMPP bot which queries Atom or RSS newsfeeds and posts the short summary to a XMPP MUC if there is a new article.

disclaimer

I am no programmer and this bot is a result of a lot of try and error. There are probably lots of quirks that are remains of some wrong paths I went in between. Also a lot is probably solved in a hacky way due to missing experience.

Anyway, it works (for me at least) and so I upload this here. Recommendations about what can be done better improved and so on are very welcome.

requirements

  • go >= 1.18

installation

You will find the binary in $GOPATH/bin or, if set, $GOBIN.

$ go install salsa.debian.org/mdosch/feed-to-muc@latest

configuration

If the flag -config is not used the configuration is expected at $HOME/.config/feed-to-muc/config.json in this format:

{
"ServerAddress": "example.com:5222",
"BotJid":        "feedbot@example.com",
"Password":      "ChangeThis!",
"Muc":           "muc-to-feed@conference.example.com",
"MucNick":       "feedbot",
"Contact":       "xmpp:botadmin@example.com",
"MaxArticles":    5,
"RefreshTime":    30,
"NoExcerpt":     false,
"Quiet":         false,
"Filter":        [ "submitted by", "[link]" ],
"FilterMessage": [ "Block me!", "Block me too!" ],
"Feeds":         [ "https://www.debian.org/News/news",
                 "https://www.debian.org/security/dsa-long",
                 "https://www.reddit.com/r/FDroidUpdates/new.rss" ]
}

MaxArticles is the maximum number of articles that are sent per feed and query. If NoExcerpt is set to true no excerpt will be posted. RefreshTime defines the interval for checking the feeds in seconds.

With Filter you can specify strings for filtering out lines beginning with those strings, with FilterMessage you can filter out complete postings containing the string.

Contact is for providing contact information about who is running the bot.

If you don't want additional noise in the MUC you can set Quiet to disable bot queries (e.g. contact) in the MUC (queries per private message are still available).