noisytoot
/
rubyserv-iirc
1
0
Fork 1
Code Issues Pull Requests 1 Projects Releases Wiki Activity

WIP: Wrap lines in README #1

Draft
harriet wants to merge 1 commits from harriet/rubyserv-iirc:master into master
pull from: harriet/rubyserv-iirc:master
merge into: noisytoot:master
Conversation 0 Commits 1 Files Changed 1 +8 -5
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,7 +1,8 @@
# RubyServ-IIRC
This is a port of [RubyServ](https://gitea.pissnet.ltd/piss.guru/rubyserv) to [IIRC](https://git.sr.ht/~mooff/iirc).
It is an IRC bot that allows evaluation of arbitrary Ruby expressions and shell commands.
You should run it in a container and/or VM as it has no sandboxing.
This is a port of [RubyServ](https://gitea.pissnet.ltd/piss.guru/rubyserv) to
[IIRC](https://git.sr.ht/~mooff/iirc). It is an IRC bot that allows evaluation
of arbitrary Ruby expressions and shell commands. You should run it in a
container and/or VM as it has no sandboxing.
## Configuration
Environment variables and Redis keys are used for configuration.
@ -9,8 +10,10 @@ Environment variables and Redis keys are used for configuration.
### Limitations
The following things are currently not configurable but may be in the future:
- When connecting to an IRC server, TLS is always used but the certificate is not verified.
- Only opers can use the bot. The server must support `solanum.chat/oper` or `letspiss.net/hiddenoper`.
- When connecting to an IRC server, TLS is always used but the certificate is
not verified.
- Only opers can use the bot. The server must support `solanum.chat/oper` or
`letspiss.net/hiddenoper`.
### Environment variables
- `IRC_HOST`: Host of IRC server to connect to, default: `localhost`.