[onionperf/master] Document the BASETORRC environment variable.

commit bfe5d16e1ae315e8914d6a48225af1aa31f1e16c Author: Philipp Winter <phw@nymity.ch> Date: Fri May 15 14:35:49 2020 -0700 Document the BASETORRC environment variable. This fixes <https://bugs.torproject.org/33435>. --- onionperf/docs/onionperf.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/onionperf/docs/onionperf.rst b/onionperf/docs/onionperf.rst index 7070b31..471a29a 100644 --- a/onionperf/docs/onionperf.rst +++ b/onionperf/docs/onionperf.rst @@ -136,6 +136,14 @@ Download files using specified configuration file for the Tor client (default: d --torserver-conf-file FILE +In addition to specifying configuration files, you can pass newline-separated +Tor configuration options to the Tor process by adding them to the +:code:`BASETORRC` environment variable. These options are prepended to all other +configuration options. Here is an example which prepends the options +:code:`Option1 Foo` and :code:`Option2 Bar` to Tor's configuration file: :: + + BASETORRC=$'Option1 Foo\nOption2 Bar' onionperf ... + Download files using specified configuration file for the Tor server (default: disabled) :: --additional-client-conf STRING
participants (1)
-
karsten@torproject.org