From 9628d41b8ed49e21a05bb8623c720fe4ba5b9714 Mon Sep 17 00:00:00 2001 From: Paige Thompson Date: Sun, 5 Jan 2025 08:38:44 -0800 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fbc69c5..378c9bf 100644 --- a/README.md +++ b/README.md @@ -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: ```