relay/README.md

35 lines
760 B
Markdown

**IRC Relay**
A multi chan irc relay in python. Based on fellow xfnw's single chan
[relay](https://tildegit.org/xfnw/relay).
Use at your own risk!
It's prone to netsplits (but you can let your service auto-retry when it exits)
---
**Features**
Please read the config files. Or better, read `main.py`.
It supports formatted logging written to `./log.txt` by default (see config).
Search for `[MANUAL]` prefix for lesser noisy messages and use the per-server
messages for debugging.
You are of course welcome to join the channels referenced in the default config
examples!
---
**Setup**
- Clone repo
- Set up virtualenv
- Install `requirements.txt`
- `cp config.example.py config.py`
- Edit the config
- Copy and adapt `relay.service`
- ???
- Profit!