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