supernets/inspircd
supernets/inspircd
4
Fork 1
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Paige Thompson 2025-01-05 08:38:44 -08:00 committed by root
parent b76e71906d
commit 9628d41b8e
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,7 +1,13 @@
# Getting started
This docker configuration relies on the host network driver meaning it doesn't setup any internal networks or even a separate NetNS. Your
mileage may vary if you change the intended network driver for Docker.
mileage may vary if you change the intended network driver for Docker. There are a few caveats to how this is designed:
- Some configuration is managed through `config.env` and exported to the Docker container as environment variables; This can help minimize convergence
between hosts but results in a configuration that cannot be changed with a simple `/quote REHASH`.
- inspircd autoloads any `.conf` file from the `custom/` directory (it's mapped into the container from the `docker-compose.yml` file.
- Environment variables are referenced in the configuration files using `&env.ENV_VAR_NAME;` and this usage can be found throughout the configuration.
- Changing the `config.env` means that the container must be re-created: `docker-compose up -d`
## Hub
- copy `config.env.example` to `config.env` and edit
- copy `include.conf.example` to `custom/include.conf` and edit (don't delete) as much as possible for now
@ -89,7 +95,7 @@ the leaf server (these files go in `custom/` and should also be named `server.cr
provider="gnutls">
```
and also change the bind for `6697` to use the `supernets_ssl` SSL profile:
and also change the bind for `6697` to use the `supernets_ssl` profile:
```
<bind address="*"