.\" Man page generated from reStructuredText.
.
.TH "ONIONBALANCE-CONFIG" "1" "May 16, 2022" "0.2.2" "Onionbalance"
.SH NAME
onionbalance-config \- tool for generating onionbalance config files and keys
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
The \fBonionbalance\-config\fP tool is the fastest way to generate the necessary
keys and config files to get your onion service up and running.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ onionbalance\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
When called without any arguments, the config generator will run in an
interactive mode and prompt for user input.
.sp
The \fBmaster\fP directory should be stored on the management server while
the other \fBinstance\fP directories should be transferred to the respective
backend servers.
.SH FILES
.INDENT 0.0
.TP
.B master/config.yaml
This is the configuration file that is used my the Onionbalance management
server.
.TP
.B master/<ONION_ADDRESS>.key
The private key which will become the public address and identity for your
onion service. It is essential that you keep this key secure.
.TP
.B master/torrc\-server
A sample Tor configuration file which can be used with the Tor instance
running on the management server (v2\-only).
.TP
.B srv/torrc\-instance
A sample Tor config file which contains the Tor \fBHiddenService*\fP options
needed for your backend Tor instance (v2\-only).
.TP
.B srv/<ONION_ADDRESS>/private_key
Directory containing the private key for your backend onion service instance.
This key is less critical as it can be rotated if lost or compromised (v2\-only).
.UNINDENT
.SH SEE ALSO
.sp
Full documentation for the \fBOnionbalance\fP software is available at
\fI\%https://onionbalance.readthedocs.org/\fP
.SH AUTHOR
George Kadianakis, Donncha O'Cearbhaill <asn@torproject.org>
.\" Generated by docutils manpage writer.
.