1ONIONBALANCE-CONFIG(1)           OnionBalance           ONIONBALANCE-CONFIG(1)
2
3
4

NAME

6       onionbalance-config - tool for generating onionbalance config files and
7       keys
8

DESCRIPTION

10       The onionbalance-config tool is the fastest way to generate the  neces‐
11       sary keys and config files to get your onion service up and running.
12
13          $ onionbalance-config
14
15       When  called without any arguments, the config generator will run in an
16       interactive mode and prompt for user input.
17
18       The master directory should be stored on the  management  server  while
19       the  other instance directories should be transferred to the respective
20       backend servers.
21

COMMAND-LINE OPTIONS

23   onionbalance-config
24       onionbalance distributes the requests for a Tor hidden services  across
25       multiple Tor instances.
26
27          usage: onionbalance-config [-h] [-i IP] [-p PORT] [-s SOCKET] [-c CONFIG]
28                                     [-v VERBOSITY] [--version]
29
30       -h, --help
31              show this help message and exit
32
33       -i <ip>, --ip <ip>
34              Tor controller IP address
35
36       -p <port>, --port <port>
37              Tor controller port
38
39       -s <socket>, --socket <socket>
40              Tor unix domain control socket location
41
42       -c <config>, --config <config>
43              Config file location
44
45       -v <verbosity>, --verbosity <verbosity>
46              Minimum  verbosity  level  for  logging.  Available in ascending
47              order: debug, info, warning, error, critical).  The  default  is
48              info.
49
50       --version
51              show program's version number and exit
52

FILES

54       master/config.yaml
55              This  is the configuration file that is used my the OnionBalance
56              management server.
57
58       master/<ONION_ADDRESS>.key
59              The private key which will become the public address  and  iden‐
60              tity for your hidden service. It is essential that you keep this
61              key secure.
62
63       master/torrc-server
64              A sample Tor configuration file which can be used with  the  Tor
65              instance running on the management server.
66
67       srv/torrc-instance
68              A  sample  Tor config file which contains the Tor HiddenService*
69              options needed for your backend Tor instance.
70
71       srv/<ONION_ADDRESS>/private_key
72              Directory containing the private key for you backend hidden ser‐
73              vice  instance.   This key is less critical as it can be rotated
74              if lost or compromised.
75

SEE ALSO

77       Full documentation  for  the  OnionBalance  software  is  available  at
78       https://onionbalance.readthedocs.org/
79

AUTHOR

81       Donncha O'Cearbhaill <donncha@donncha.is>
82
83
84
85
860.1.4                            Jul 20, 2018           ONIONBALANCE-CONFIG(1)
Impressum