atheme/README.md

23 lines
824 B
Markdown
Raw Normal View History

2024-11-02 04:43:43 +00:00
# Instructions
2025-01-05 14:39:20 +00:00
## Remote with TLS
2025-01-05 14:42:05 +00:00
since atheme doesn't support TLS uplinks, (https://github.com/atheme/atheme/issues/265) stunnel has to be used for remote TLS
encryption (this assumes stunnel is running on the hub already):
2025-01-05 14:39:20 +00:00
- `cd stunnel/`
- Copy `stunnel.conf.example` to `stunnel.conf` then edit
2025-01-05 14:42:05 +00:00
- retrieve certificates from CA `see inspircd hub CA setup with easyrsa3`, place `ca.crt` in `ssl/`
2025-01-05 14:39:20 +00:00
- `docker-compose up -d`
2024-11-02 04:43:43 +00:00
2025-01-05 14:39:20 +00:00
## docker-compose
2024-11-02 04:43:43 +00:00
- Copy `config.env.example` to `config.env` and edit
2025-01-05 14:39:20 +00:00
- Copy `data/include.default.conf` to `data/include.conf` and edit
- `docker-compose build`
2024-11-02 04:43:43 +00:00
- `docker-compose up -d`
2025-01-05 21:40:45 +00:00
## Administration
- To enable debugging add `-d` to `DAEMON_FLAGS` in `config.env`
- `docker-compose up -d`
- `docker logs -f atheme-atheme-1`
### Anope migration
2025-01-05 14:39:20 +00:00
See `tools/` for `anope2atheme.php`. YMMV