From 356ac596d0be1142ec1e213bcbe78cf2848ba284 Mon Sep 17 00:00:00 2001
From: Benjamin Goering <bengoering@gmail.com>
Date: Wed, 21 Feb 2018 20:39:09 -0800
Subject: [PATCH] explain files

---
 build/bin/install-dependencies |  8 ++++++++
 build/bin/lint                 | 10 ++++++++++
 build/bin/run                  |  1 -
 build/bin/set-public-ip        | 11 +++++++++++
 build/bin/tunneldigger         |  8 ++++++++
 build/docker-entrypoint.sh     | 10 +++++++++-
 build/docker/build             | 10 ++++++++++
 build/docker/docker-build      |  8 ++++++++
 build/docker/docker-cmd        |  8 ++++++++
 build/remote                   | 12 ++++++++++++
 10 files changed, 84 insertions(+), 2 deletions(-)
 delete mode 100755 build/bin/run

diff --git a/build/bin/install-dependencies b/build/bin/install-dependencies
index c38b870..691a014 100755
--- a/build/bin/install-dependencies
+++ b/build/bin/install-dependencies
@@ -1,5 +1,13 @@
 #!/usr/bin/env bash
 
+usage () {
+cat <<HELP_USAGE
+$0 
+
+Install dependency packages required to run an exitnode.
+HELP_USAGE
+}
+
 set -e
 
 release_info="$(cat /etc/*-release)"
diff --git a/build/bin/lint b/build/bin/lint
index 2d3abbb..180ace1 100755
--- a/build/bin/lint
+++ b/build/bin/lint
@@ -3,6 +3,16 @@
 # set -x
 set -e
 
+usage () {
+cat <<HELP_USAGE
+$0 [file]
+
+check bash scripts here for common mistakes
+
+[file] - file to lint for common bash mistakes. If omitted, all files will be checked
+HELP_USAGE
+}
+
 file="$1"
 
 if [ -z "$file" ]; then
diff --git a/build/bin/run b/build/bin/run
deleted file mode 100755
index f1f641a..0000000
--- a/build/bin/run
+++ /dev/null
@@ -1 +0,0 @@
-#!/usr/bin/env bash
diff --git a/build/bin/set-public-ip b/build/bin/set-public-ip
index d1230ef..c09d71c 100755
--- a/build/bin/set-public-ip
+++ b/build/bin/set-public-ip
@@ -1,5 +1,16 @@
 #!/usr/bin/env bash
 
+usage () {
+cat <<HELP_USAGE
+$0 [public_ip]
+
+set the public ip address of this exitnode.
+Configures babeld, tunneldigger, etc and restarts them.
+
+[public_ip] - public_ip to lint for common bash mistakes. If omitted, all files will be checked
+HELP_USAGE
+}
+
 cd "$(dirname "$0")" || return
 
 . ../variables
diff --git a/build/bin/tunneldigger b/build/bin/tunneldigger
index e098ba6..5569256 100755
--- a/build/bin/tunneldigger
+++ b/build/bin/tunneldigger
@@ -1,4 +1,12 @@
 #!/usr/bin/env bash
 
+usage () {
+cat <<HELP_USAGE
+$0
+
+Run tunneldigger in the foreground (alternative to /etc/init.d/tunneldigger)
+HELP_USAGE
+}
+
 cd /opt/tunneldigger || return
 exec /opt/tunneldigger/broker/env_tunneldigger/bin/python -m broker.main /opt/tunneldigger/broker/l2tp_broker.cfg
diff --git a/build/docker-entrypoint.sh b/build/docker-entrypoint.sh
index f311562..3b5fe57 100755
--- a/build/docker-entrypoint.sh
+++ b/build/docker-entrypoint.sh
@@ -1,12 +1,20 @@
 #!/bin/bash
 
+usage () {
+cat <<HELP_USAGE
+$0
+
+Docker entrypoint. Configures services for PUBLIC_IP env var, starts services.
+HELP_USAGE
+}
+
 # print each line
 # set -x
 
 # exit on error
 set -e
 
-./build/bin/set-public-ip "$EXITNODE_PUBLIC_IP"
+./build/bin/set-public-ip "$PUBLIC_IP"
 
 service sudomesh-gateway start
 service tunneldigger start
diff --git a/build/docker/build b/build/docker/build
index 31cb3bd..3358e6c 100755
--- a/build/docker/build
+++ b/build/docker/build
@@ -1,5 +1,15 @@
 #!/usr/bin/env bash
 
+usage () {
+cat <<HELP_USAGE
+$0 [-t tag]
+
+build a docker image for exitnode
+
+[-t]    tag the docker image
+HELP_USAGE
+}
+
 cd "$(dirname "$0")"
 EXITNODE_DIR=../../
 
diff --git a/build/docker/docker-build b/build/docker/docker-build
index 9b611ee..d28fa7d 100755
--- a/build/docker/docker-build
+++ b/build/docker/docker-build
@@ -5,6 +5,14 @@ cd "$(dirname "$0")"
 # set -x
 set -e
 
+usage () {
+cat <<HELP_USAGE
+$0
+
+Meant to be run by the Dockerfile upon \`docker build\`
+HELP_USAGE
+}
+
 echo "docker-build PUBLIC_IP=$PUBLIC_IP"
 
 ../../create_exitnode.sh "$PUBLIC_IP"
diff --git a/build/docker/docker-cmd b/build/docker/docker-cmd
index 6301322..eabdb32 100755
--- a/build/docker/docker-cmd
+++ b/build/docker/docker-cmd
@@ -1,5 +1,13 @@
 #!/usr/bin/env bash
 
+usage () {
+cat <<HELP_USAGE
+$0
+
+Meant to be the default cmd run by the Dockerfile upon \`docker run\`
+HELP_USAGE
+}
+
 cd "$(dirname "$0")" || return
 
 exec ../bin/tunneldigger
diff --git a/build/remote b/build/remote
index 29ac4fb..2017902 100755
--- a/build/remote
+++ b/build/remote
@@ -3,6 +3,18 @@
 # This script should provision a remote linux server as an exit node
 # usage: PUBLIC_IP=165.227.241.194 ./build/remote root@165.227.241.194
 
+usage () {
+cat <<HELP_USAGE
+$0 [ssh_host]@[ssh_host]
+
+Provision an exitnode by SSHing into a remote server.
+
+[ssh_user] - usually 'root'
+[ssh_host] - Public IP address that your exitnode will be available at
+
+HELP_USAGE
+}
+
 # set -x 
 # set -e