Update README.md

This commit is contained in:
Paige Thompson 2025-01-05 09:38:36 -08:00 committed by root
parent 632fc05f9c
commit 31bbed9c02

View File

@ -8,6 +8,14 @@ mileage may vary if you change the intended network driver for Docker. There are
- Environment variables are referenced in the configuration files using `&env.ENV_VAR_NAME;` and this usage can be found throughout the configuration. - 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` - Changing the `config.env` means that the container must be re-created: `docker-compose up -d`
When editing configuration, use generated passwords everywhere possible:
```
echo $(dd if=/dev/urandom bs=1024 count=1 status=none | sha256sum | base64 | head -c 64
```
Some passwords need to be consistent (uplink send/recv passwords for example) across servers.
## Hub ## Hub
- copy `config.env.example` to `config.env` and edit - 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 - copy `include.conf.example` to `custom/include.conf` and edit (don't delete) as much as possible for now