roughnecks/feed-to-muc
1
0
Fork 0
mirror of https://salsa.debian.org/mdosch/feed-to-muc.git synced 2024-11-25 15:38:40 +01:00
Code Issues Projects Releases Packages Wiki Activity
An xmpp bot which posts to a MUC if there is an update in newsfeeds.
94 commits 5 branches 0 tags 6.4 MiB
Go 100%
Find a file
Martin Dosch 0247521457 Update go modules.
2023-03-09 10:46:42 +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 Update html2text location. 2022-12-16 11:57:42 +01:00
go.mod Update go modules. 2023-03-09 10:46:42 +01:00
go.sum Update go modules. 2023-03-09 10:46:42 +01:00
LICENSE Add LICENSE 2018-07-13 21:11:57 +00:00
main.go Add option to filter complete articles. 2020-07-06 21:06:00 +02:00
openConfig.go Cherrypicked 62dfe9d3ac 2019-06-14 15:59:33 +02:00
processStanzas.go Change s.d.o. username from mdosch-guest to mdosch. 2020-05-14 16:09:08 +02:00
README.md [codespell]: Fix typos. 2022-08-21 12:07:30 +02:00
removeTracking.go [codespell]: Fix typos. 2022-08-21 12:07:30 +02:00
sendPings.go [golangci-lint] Simplified comparisons to bool constant. 2019-06-14 16:11:13 +02:00

README.md

feed-to-muc

about

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

installation

If you have GOPATH set just run this commands:

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

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

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).