add long form to all cli argument + docs update

Author: dlemel8

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "tunneler"
-version = "0.4.0"
+version = "0.4.1"
 authors = ["Daniel Segal <[email protected]>"]
 edition = "2018"
 license = "MIT"

Cargo.toml

@@ -32,11 +32,14 @@ docker run -e LOCAL_PORT=45301 \
 ```
 ### Option 2: locally compiled binary
 ```sh
-READ_TIMEOUT_IN_MILLISECONDS=100 \
-IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
-TUNNELED_TYPE=tcp \
-LOG_LEVEL=debug \
-./target/debug/client 1.1.1.1 53 dns
+./target/release/client \
+  --tunneled-type tcp \
+  --remote-address 1.1.1.1 \
+  --remote-port 53 \
+  --log-level debug \
+  dns \
+  --read-timeout-in-milliseconds 100 \
+  --idle-client-timeout-in-milliseconds 30000
 ```
 Run docker image or compiled binary with `--help` for more information
 
@@ -45,8 +48,8 @@ This repo contains a few server deployment examples using Docker Compose:
 * Speed Test - iperf3 server exposed via all supported tunnels, allow you to compare tunnels speed.
 * Authoritative DNS - Redis server exposed via DNS tunnel on port UDP/53. Since tunnel does not verify clients, Redis
   authentication is needed.
-* Pipeline - Redis server exposed via TLS tunnel that itself exposed via DNS tunnel. on port UDP/53. Since tunnel does 
-  verify clients, Redis authentication is not used.
+* Pipeline - Redis server exposed via TLS tunnel that itself exposed via DNS tunnel. Since tunnel does verify clients, 
+  Redis authentication is not used.
 
 You can run each example locally or deploy it using Terraform and Ansible. See more information [here](examples/README.md).
 

README.md

@@ -28,7 +28,7 @@ CA_CERT=../../pki/ca.crt \
 CERT=../../pki/client.crt \
 KEY=../../pki/client.key \
 SERVER_HOSTNAME=server.tunneler \
-../../target/debug/client tls
+../../target/release/client tls
 ```
 Then, run the service client. for example, for Speed Test run:
 ```sh
@@ -74,7 +74,7 @@ TUNNELED_TYPE=tcp \
 CLIENT_SUFFIX=.dlemel8.xyz \
 READ_TIMEOUT_IN_MILLISECONDS=100 \
 IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
-../target/debug/client dns
+../target/release/client dns
 ```
 Then, run the service client. for example, for Authoritative DNS run:
 ```sh

examples/README.md

@@ -19,7 +19,7 @@ TUNNELED_TYPE=tcp \
 READ_TIMEOUT_IN_MILLISECONDS=100 \
 IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
 LOG_LEVEL=debug \
-../../target/debug/client dns
+../../target/release/client dns
 ```
 
 Then, run Redis client and direct it to the tunnel local port, for example:
@@ -37,7 +37,7 @@ TUNNELED_TYPE=tcp \
 CLIENT_SUFFIX=.dlemel8.xyz \
 READ_TIMEOUT_IN_MILLISECONDS=100 \
 IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
-../../target/debug/client dns
+../../target/release/client dns
 ```
 
 Then, run Redis client and direct it to the tunnel local port, for example:

examples/authoritative_dns/README.md

@@ -20,7 +20,7 @@ LOG_LEVEL=debug \
 TUNNELED_TYPE=tcp \
 READ_TIMEOUT_IN_MILLISECONDS=100 \
 IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
-../../target/debug/client dns
+../../target/release/client dns
 
 LOCAL_PORT=8887 \
 REMOTE_PORT=8886 \
@@ -31,7 +31,7 @@ CA_CERT=../../pki/ca.crt \
 CERT=../../pki/client.crt \
 KEY=../../pki/client.key \
 SERVER_HOSTNAME=server.tunneler \
-../../target/debug/client tls
+../../target/release/client tls
 ```
 
 Then, run Redis client and direct it to the TLS tunnel local port, for example:

examples/pipeline/README.md

@@ -30,7 +30,7 @@ CA_CERT=../../pki/ca.crt \
 CERT=../../pki/client.crt \
 KEY=../../pki/client.key \
 SERVER_HOSTNAME=server.tunneler \
-../../target/debug/client tls
+../../target/release/client tls
 ```
 
 Then, run iperf3 client and direct it to the tunnel local port, for example:
@@ -50,7 +50,7 @@ TUNNELED_TYPE=tcp \
 LOG_LEVEL=debug \
 READ_TIMEOUT_IN_MILLISECONDS=100 \
 IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
-../../target/debug/client dns
+../../target/release/client dns
 
 LOCAL_PORT=8888 \
 REMOTE_PORT=53536 \
@@ -59,7 +59,7 @@ TUNNELED_TYPE=udp \
 LOG_LEVEL=debug \
 READ_TIMEOUT_IN_MILLISECONDS=100 \
 IDLE_CLIENT_TIMEOUT_IN_MILLISECONDS=30000 \
-../../target/debug/client dns
+../../target/release/client dns
 ```
 
 Then, run iperf3 client and direct it to the tunnels local port, for example:

examples/speed_test/README.md

@@ -10,21 +10,21 @@ use trust_dns_resolver::Resolver;
 pub enum TunnelerType {
     Tcp,
     Dns {
-        #[structopt(env)]
+        #[structopt(long, env)]
         read_timeout_in_milliseconds: u64,
-        #[structopt(env)]
+        #[structopt(long, env)]
         idle_client_timeout_in_milliseconds: u64,
-        #[structopt(default_value = "", env)]
+        #[structopt(default_value = "", long, env)]
         client_suffix: String,
     },
     Tls {
-        #[structopt(env)]
+        #[structopt(long, env)]
         ca_cert: PathBuf,
-        #[structopt(env)]
+        #[structopt(long, env)]
         cert: PathBuf,
-        #[structopt(env)]
+        #[structopt(long, env)]
         key: PathBuf,
-        #[structopt(env)]
+        #[structopt(long, env)]
         server_hostname: String,
     },
 }
@@ -53,13 +53,13 @@ pub struct Cli {
     #[structopt(subcommand)]
     pub tunneler_type: TunnelerType,
 
-    #[structopt(env, possible_values = &TunneledType::variants(), case_insensitive = true)]
+    #[structopt(long, env, possible_values = &TunneledType::variants(), case_insensitive = true)]
     pub tunneled_type: TunneledType,
 
-    #[structopt(env, parse(try_from_str = parse_or_resolve_ip))]
+    #[structopt(long, env, parse(try_from_str = parse_or_resolve_ip))]
     pub remote_address: IpAddr,
 
-    #[structopt(env)]
+    #[structopt(long, env)]
     pub remote_port: u16,
 
     #[structopt(default_value = "0.0.0.0", long, env)]