From 7d918c4da2a71ecc60713d40ea53e4c8faeef45a Mon Sep 17 00:00:00 2001 From: Logan oos Even <46396513+Logan007@users.noreply.github.com> Date: Wed, 13 Jan 2021 00:56:50 +0545 Subject: [PATCH] updated ConfigurationFiles.md --- doc/ConfigurationFiles.md | 40 +++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/ConfigurationFiles.md b/doc/ConfigurationFiles.md index 62f5d2f..cb1c347 100644 --- a/doc/ConfigurationFiles.md +++ b/doc/ConfigurationFiles.md @@ -1,6 +1,6 @@ # Configuration Files -To help deployment of locally different configurations, n2n supports the use of configuration files for `edge` and `supernode`. +To help deployment and better handle locally different configurations, n2n supports the optional use of configuration files for `edge` and `supernode`. They are plain text files and contain the desired command line options, **one per line**. @@ -18,6 +18,7 @@ translates into the following `edge.conf` file: -a 192.168.100.1 -f -l supernode.ntop.org:7777 +-A5 ``` which can be loaded by @@ -26,18 +27,6 @@ which can be loaded by sudo ./edge edge.conf ``` -The `.conf` file syntax also allows `=` between parameter and its option: - -``` --c=mynetwork --k=mysecretpass --a=192.168.100.1 --f --l=supernode.ntop.org:7777 -``` - -When used with `=`, there is no whitespace allowed between parameter, delimter (`=`), and option. So, do **not** put `-c = mynetwork` – it is required to be `-c=mynetwork`. - Comment lines starting with a hash '#' are ignored. ``` @@ -48,26 +37,37 @@ Comment lines starting with a hash '#' are ignored. -k mysecretpass -a 192.168.100.1 -f +-A5 # --- supernode section --- -l supernode.ntop.org:7777 ``` -Long options can be used as well. Please note the double minus/dash character `--`, just like on command line: +Long options can be used as well. Please note the double minus/dash-character `--`, just like you would use them on the command line with long options: ``` -# automated edge configuration -# created by bot7 -# on April 31, 2038 – 1800Z --community mynetwork -k mysecretpass -a 192.168.100.1 -f -# --- supernode section --- +-A5 -l supernode.ntop.org:7777 ``` If using a configuration file, its filename needs to be supplied as first parameter to `edge` or `supernode`. If required, additional command line parameters can be supplied afterwards: ``` -sudo edge edge.conf -A5 -``` \ No newline at end of file +sudo edge edge.conf -z1 -I myComputer +``` + +Finally, the `.conf` file syntax also allows `=` between parameter and its option: + +``` +-c=mynetwork +-k=mysecretpass +-a=192.168.100.1 +-f +-A5 +-l=supernode.ntop.org:7777 +``` + +When used with `=`, there is no whitespace allowed between parameter, delimter (`=`), and option. So, do **not** put `-c = mynetwork` – it is required to be `-c=mynetwork`.