diff options
| author | ubq323 <ubq323@ubq323.website> | 2022-10-31 19:47:20 +0000 |
|---|---|---|
| committer | ubq323 <ubq323@ubq323.website> | 2022-10-31 19:47:20 +0000 |
| commit | f5eee946f2c2028c5cbc7b968a6ffef7f7972f3b (patch) | |
| tree | 1e8eb64e16eb688eb4223ea3db7250730cc51583 | |
| parent | 998156467de2ee0f52c3f5bc84952abaf9d642ad (diff) | |
add readme
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..2dfc8e1 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# apiobot +unix domain socket interface to irc + +this program connects to an irc server and joins a predetermined set of channels. it then creates some unix datagram sockets, one for each joined channel, and listens on all of them. when a message is received on one of these sockets, it sends that message to the corresponding irc channel. + +the owning group of each of the created unix sockets is set to a predetermined group, and that group is given permission to write to each of the sockets, meaning any user in that group is able to send messages to irc. there currently isn't any way to disable this. + +the parameters of the irc connection, the directory into which the created unix sockets should be placed, and the group that should own them can all be configured in conf.h. the list of irc channels to join can be changed in irc.c. + +## running +`make run`, or `make` followed by `./apiobot`. + +# webhooks.go +this go program runs a web server which can be used to provide a web interface to irc, by sending messages sent to it to one of apiobot's unix sockets. it currently does not support multiple channels and is also not very well designed. |