From e36846a5b2b4534c6c892b48cae8808d07a7b720 Mon Sep 17 00:00:00 2001 From: Thomas Leplus Date: Sat, 2 Nov 2024 17:50:51 +0545 Subject: [PATCH] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 993877c..9c01a93 100644 --- a/README.md +++ b/README.md @@ -51,8 +51,8 @@ available: Note that the defaults are the same as Tor's default if the configuration option is not set. -You can use the `-m` option of Docker to mount a custom template the -inmage at `/etc/tor/torrc.template`. The templating engine +You can use the `-m` option of Docker to mount a custom template in the +image at `/etc/tor/torrc.template`. The templating engine (`envsubst`) will only replace specific environment variables in the template. These are controlled by the environment variable `SHELL_FORMAT` (the default list is @@ -64,7 +64,10 @@ environment variable `SHELL_FORMAT_EXTRA`. Be careful to escape the `$` characters since you don't want them to be interpolated when defining `SHELL_FORMAT` or `SHELL_FORMAT_EXTRA`. -Of course you can also build an image on top of this one with a custom `torrc.template`. +The out-of-the-box torrc.template also loads any file in the +`/etc/tor/torrc.d/` directory with the `.conf` extension so you can +mount your custom torrc configuration file(s) there. This is similar +to the `TORRC_APPEND` environment variable but using files instead. For troubleshooting, you can enable verbose logging by setting the value of environment variable `DEBUG` to `true`.