Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasleplus committed Nov 2, 2024
1 parent 48fa1a8 commit e36846a
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`.
Expand Down

0 comments on commit e36846a

Please sign in to comment.