Loading docs/config.md +14 −0 Original line number Diff line number Diff line Loading @@ -19,6 +19,9 @@ backend servers. ## Files Default configuration file locations when running Onionbalance as a local, user service: * `config/config.yaml`: this is the configuration file that is used by the Onionbalance management server. Loading @@ -29,6 +32,17 @@ backend servers. `dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key`. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: * `/etc/onionbalance/config.yaml`: the global configuration file, which contains services entries. * `/etc/onionbalance/ONION_ADDRESS.key`: service instance private key file. Each private key file is named after the .onion address, so `ONION_ADDRESS.key` will be actually like `dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key`. It is essential that you keep these files secure. ## Environment variables * `ONIONBALANCE_CONFIG`: Override the location for the Onionbalance Loading docs/man/onionbalance-config.1 +19 −4 Original line number Diff line number Diff line Loading @@ -56,13 +56,16 @@ options: .PP When called without any arguments, the config generator will run in an interactive mode and prompt for user input. .PP The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. .SH CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: .SH FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. .PP Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the \[en]output option when invoking onionbalance\-config): .TP config/config.yaml This is the configuration file that is used by the Onionbalance Loading @@ -75,6 +78,18 @@ Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. .PP System\-wide files, when running Onionbalance as a system service: .TP /etc/onionbalance/config.yaml The global configuration file, which contains services entries. .TP /etc/onionbalance/ONION_ADDRESS.key Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. .SH EXIT STATUS onionbalance\-config exits with a non\-zero status in case of errors. .PP Loading docs/man/onionbalance-config.1.txt +20 −3 Original line number Diff line number Diff line Loading @@ -62,9 +62,6 @@ and config files to get your onion service up and running. When called without any arguments, the config generator will run in an interactive mode and prompt for user input. The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. # CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: Loading @@ -73,6 +70,14 @@ This is a sample configuration file that can be adapted: # FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the --output option when invoking onionbalance-config): config/config.yaml : This is the configuration file that is used by the Onionbalance management server. Loading @@ -85,6 +90,18 @@ config/ONION_ADDRESS.key dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: /etc/onionbalance/config.yaml : The global configuration file, which contains services entries. /etc/onionbalance/ONION_ADDRESS.key : Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. # EXIT STATUS onionbalance-config exits with a non-zero status in case of errors. Loading docs/man/onionbalance-config.1.txt.tmpl +20 −3 Original line number Diff line number Diff line Loading @@ -22,9 +22,6 @@ and config files to get your onion service up and running. When called without any arguments, the config generator will run in an interactive mode and prompt for user input. The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. # CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: Loading @@ -33,6 +30,14 @@ This is a sample configuration file that can be adapted: # FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the --output option when invoking onionbalance-config): config/config.yaml : This is the configuration file that is used by the Onionbalance management server. Loading @@ -45,6 +50,18 @@ config/ONION_ADDRESS.key dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: /etc/onionbalance/config.yaml : The global configuration file, which contains services entries. /etc/onionbalance/ONION_ADDRESS.key : Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. # EXIT STATUS onionbalance-config exits with a non-zero status in case of errors. Loading docs/man/onionbalance-config.md +20 −3 Original line number Diff line number Diff line Loading @@ -60,9 +60,6 @@ and config files to get your onion service up and running. When called without any arguments, the config generator will run in an interactive mode and prompt for user input. The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. ## CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: Loading @@ -71,6 +68,14 @@ This is a sample configuration file that can be adapted: ## FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the --output option when invoking onionbalance-config): config/config.yaml : This is the configuration file that is used by the Onionbalance management server. Loading @@ -83,6 +88,18 @@ config/ONION_ADDRESS.key dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: /etc/onionbalance/config.yaml : The global configuration file, which contains services entries. /etc/onionbalance/ONION_ADDRESS.key : Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. ## EXIT STATUS onionbalance-config exits with a non-zero status in case of errors. Loading Loading
docs/config.md +14 −0 Original line number Diff line number Diff line Loading @@ -19,6 +19,9 @@ backend servers. ## Files Default configuration file locations when running Onionbalance as a local, user service: * `config/config.yaml`: this is the configuration file that is used by the Onionbalance management server. Loading @@ -29,6 +32,17 @@ backend servers. `dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key`. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: * `/etc/onionbalance/config.yaml`: the global configuration file, which contains services entries. * `/etc/onionbalance/ONION_ADDRESS.key`: service instance private key file. Each private key file is named after the .onion address, so `ONION_ADDRESS.key` will be actually like `dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key`. It is essential that you keep these files secure. ## Environment variables * `ONIONBALANCE_CONFIG`: Override the location for the Onionbalance Loading
docs/man/onionbalance-config.1 +19 −4 Original line number Diff line number Diff line Loading @@ -56,13 +56,16 @@ options: .PP When called without any arguments, the config generator will run in an interactive mode and prompt for user input. .PP The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. .SH CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: .SH FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. .PP Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the \[en]output option when invoking onionbalance\-config): .TP config/config.yaml This is the configuration file that is used by the Onionbalance Loading @@ -75,6 +78,18 @@ Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. .PP System\-wide files, when running Onionbalance as a system service: .TP /etc/onionbalance/config.yaml The global configuration file, which contains services entries. .TP /etc/onionbalance/ONION_ADDRESS.key Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. .SH EXIT STATUS onionbalance\-config exits with a non\-zero status in case of errors. .PP Loading
docs/man/onionbalance-config.1.txt +20 −3 Original line number Diff line number Diff line Loading @@ -62,9 +62,6 @@ and config files to get your onion service up and running. When called without any arguments, the config generator will run in an interactive mode and prompt for user input. The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. # CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: Loading @@ -73,6 +70,14 @@ This is a sample configuration file that can be adapted: # FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the --output option when invoking onionbalance-config): config/config.yaml : This is the configuration file that is used by the Onionbalance management server. Loading @@ -85,6 +90,18 @@ config/ONION_ADDRESS.key dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: /etc/onionbalance/config.yaml : The global configuration file, which contains services entries. /etc/onionbalance/ONION_ADDRESS.key : Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. # EXIT STATUS onionbalance-config exits with a non-zero status in case of errors. Loading
docs/man/onionbalance-config.1.txt.tmpl +20 −3 Original line number Diff line number Diff line Loading @@ -22,9 +22,6 @@ and config files to get your onion service up and running. When called without any arguments, the config generator will run in an interactive mode and prompt for user input. The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. # CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: Loading @@ -33,6 +30,14 @@ This is a sample configuration file that can be adapted: # FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the --output option when invoking onionbalance-config): config/config.yaml : This is the configuration file that is used by the Onionbalance management server. Loading @@ -45,6 +50,18 @@ config/ONION_ADDRESS.key dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: /etc/onionbalance/config.yaml : The global configuration file, which contains services entries. /etc/onionbalance/ONION_ADDRESS.key : Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. # EXIT STATUS onionbalance-config exits with a non-zero status in case of errors. Loading
docs/man/onionbalance-config.md +20 −3 Original line number Diff line number Diff line Loading @@ -60,9 +60,6 @@ and config files to get your onion service up and running. When called without any arguments, the config generator will run in an interactive mode and prompt for user input. The main directory should be stored on the management server while the other instance directories should be transferred to the respective backend servers. ## CONFIGURATION FILE FORMAT This is a sample configuration file that can be adapted: Loading @@ -71,6 +68,14 @@ This is a sample configuration file that can be adapted: ## FILES The main configuration folder should be stored on the management server while the other, backend instance data should be hosted in the respective backend servers, as usual. Default configuration file locations when running Onionbalance as a local, user service (which can be customized through the --output option when invoking onionbalance-config): config/config.yaml : This is the configuration file that is used by the Onionbalance management server. Loading @@ -83,6 +88,18 @@ config/ONION_ADDRESS.key dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. System-wide files, when running Onionbalance as a system service: /etc/onionbalance/config.yaml : The global configuration file, which contains services entries. /etc/onionbalance/ONION_ADDRESS.key : Service instance private key file. Each private key file is named after the .onion address, so ONION_ADDRESS.key will be actually like dpkhemrbs3oiv2fww5sxs6r2uybczwijzfn2ezy2osaj7iox7kl7nhad.key. It is essential that you keep these files secure. ## EXIT STATUS onionbalance-config exits with a non-zero status in case of errors. Loading
