updated readme, tweaked Dockerfile, generated index.

2018-08-08 17:40:17 -04:00
parent a405d8ecaa
commit e7a218ce57
4 changed files with 150 additions and 9 deletions
--- a/2
+++ b/2
@ -15,5 +15,5 @@ RUN install -m755 bin/eephttpd /usr/bin/eephttpd
 USER $user
 WORKDIR /opt/$user/
 VOLUME /opt/$user/
-COPY www /opt/$user/www
+COPY example/www /opt/$user/www
 CMD eephttpd -sh=$samhost -sp=$samport $args
--- a/3
+++ b/3
@ -120,3 +120,6 @@ docker-cmd:
 	@echo "    --volume $(eephttpd):/home/$(eephttpd)/ \\" >> USAGE.md
 	@echo "    eyedeekay/$(eephttpd)" >> USAGE.md
 	@echo '```' >> USAGE.md
+
+index:
+	markdown USAGE.md | tee example/www/index.html
--- a/README.md.asc
+++ b/README.md.asc
@ -157,12 +157,12 @@ their own projects. An i2p-native static site generator in the style of jekyll
 (but in go) could be cool.
 -----BEGIN PGP SIGNATURE-----

-iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAltrYfwACgkQ11wDs5te
-FOFuuwf8DWWFPTPtwTaxLJD7+P6/5WSohTU3j9FLgndK45GDs614HE727vcpyeov
-gMUo4cxpVCQsXDGzsnBzlWGrsCG93QPO83zzxZ4Z/GSNi7XwVWYWyeqbYCh0P5Jg
-jU/odscCHyeoiUu/8LXFc+Bxnd1ZJH9ihGTBC3mXPdcmrXIJRNLebEMnsLMCZRjO
-ZSRdy1gnmGdxjIPQ31qDRqQYn46ITGm3mkPSB4H1XuCbzFP2GG6bFMu1ncrd15Un
-/LZkKJEQYYgY8amoVYEgVmBUJnVk4tqxPEIL52sztg0u55BH4JMCSqaEYUdqeT+9
-SX56L+X0FG/ZECZDjf7wNV+ps3AsjQ==
-=0gal
+iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAltrY0EACgkQ11wDs5te
+FOEc3Qf9G7BaEVAyfDIH981I4yjHQFq+kdJd5jdZdq/ISs8ll8y9dWVwKo4j6cgj
+cUizhcq97SdjPt/yvZ6hnk9c6f7s0nAqfvmoYXXT2WNAbLt87/ggnb9DNOiw6rS4
+JZRtdPk845yOIJsNOb/AlvwA+ESqtG+cPxNXMFcxiBddYjQOP11hG3OmoH3VzM6O
+pax0JyAOWRVrsQlg27xYpSjYJyisjB55elx6e0J0K6AM9yxrJJVrkW8eJ+ylFU1R
+L1ngNTXzzpCsMOclGeVS0napLfB3c8yJ9NXTDywjgxsBfwZzlIL9ZqL/q+HLMaux
+5QB8lBDBRNc5LIsLO9Hw7ojNy1QzpQ==
+=E/uc
 -----END PGP SIGNATURE-----
--- a/example/www/index.html
+++ b/example/www/index.html
@ -0,0 +1,138 @@
+<h1>ephsite - Easy forwarding of local services to i2p</h1>
+
+<p>ephsite is a forwarding proxy designed to configure a tunnel for use
+with i2p. It can be used to easily forward a local service to the
+i2p network using i2p's SAM API instead of the tunnel interface.</p>
+
+<h2>usage:</h2>
+
+<p><code>
+Usage of ./bin/ephsite:
+  -access string
+        Type of access list to use, can be "whitelist" "blacklist" or "none". (default "none")
+  -accesslist value
+        Specify an access list member(can be used multiple times)
+  -dir string
+        Directory to save tunnel configuration file in.
+  -encryptlease
+        Use an encrypted leaseset(true or false) (default true)
+  -gzip
+        Uze gzip(true or false)
+  -host string
+        Target host(Host of service to forward to i2p) (default "127.0.0.1")
+  -inback int
+        Set inbound tunnel backup quantity(0 to 5) (default 4)
+  -incount int
+        Set inbound tunnel quantity(0 to 15) (default 8)
+  -ini string
+        Use an ini file for configuration(config file options override passed arguments for now.) (default "none")
+  -inlen int
+        Set inbound tunnel length(0 to 7) (default 3)
+  -invar int
+        Set inbound tunnel length variance(-7 to 7)
+  -name string
+        Tunnel name, this must be unique but can be anything. (default "forwarder")
+  -outback int
+        Set outbound tunnel backup quantity(0 to 5) (default 4)
+  -outcount int
+        Set outbound tunnel quantity(0 to 15) (default 8)
+  -outlen int
+        Set outbound tunnel length(0 to 7) (default 3)
+  -outvar int
+        Set outbound tunnel length variance(-7 to 7)
+  -port string
+        Target port(Port of service to forward to i2p) (default "8081")
+  -reduce
+        Reduce tunnel quantity when idle(true or false)
+  -reducecount int
+        Reduce idle tunnel quantity to X (0 to 5) (default 3)
+  -reducetime int
+        Reduce tunnel quantity after X (minutes) (default 10)
+  -samhost string
+        SAM host (default "127.0.0.1")
+  -samport string
+        SAM port (default "7656")
+  -save
+        Use saved file and persist tunnel(If false, tunnel will not persist after program is stopped.
+  -udp
+        UDP mode(true or false)
+  -zeroin
+        Allow zero-hop, non-anonymous tunnels in(true or false)
+  -zeroout
+        Allow zero-hop, non-anonymous tunnels out(true or false)
+</code></p>
+
+<h1>eephttpd - Static file server automatically forwarded to i2p</h1>
+
+<h2>usage:</h2>
+
+<p>eephttpd is a static http server which automatically runs on i2p with
+the help of the SAM bridge. By default it will only be available from
+the localhost and it's i2p tunnel. It can be masked from the localhost
+using a container.</p>
+
+<p><code>
+Usage of ./bin/eephttpd:
+  -a string
+        hostname to serve on (default "127.0.0.1")
+  -c    Use an encrypted leaseset(true or false)
+  -d string
+        the directory of static files to host(default ./www) (default "./www")
+  -f string
+        Use an ini file for configuration (default "none")
+  -g    Uze gzip(true or false) (default true)
+  -i    save i2p keys(and thus destinations) across reboots (default true)
+  -ib int
+        Set inbound tunnel backup quantity(0 to 5) (default 4)
+  -il int
+        Set inbound tunnel length(0 to 7) (default 3)
+  -iq int
+        Set inbound tunnel quantity(0 to 15) (default 8)
+  -iv int
+        Set inbound tunnel length variance(-7 to 7)
+  -n string
+        name to give the tunnel(default static-eepSite) (default "static-eepSite")
+  -ob int
+        Set outbound tunnel backup quantity(0 to 5) (default 4)
+  -ol int
+        Set outbound tunnel length(0 to 7) (default 3)
+  -oq int
+        Set outbound tunnel quantity(0 to 15) (default 8)
+  -ov int
+        Set outbound tunnel length variance(-7 to 7)
+  -p string
+        port to serve locally on (default "8100")
+  -r    Reduce tunnel quantity when idle(true or false)
+  -rc int
+        Reduce idle tunnel quantity to X (0 to 5) (default 3)
+  -rt int
+        Reduce tunnel quantity after X (minutes) (default 10)
+  -s string
+        the directory to save the keys in(default ./) (default ".")
+  -sh string
+        sam host to connect to (default "127.0.0.1")
+  -sp string
+        sam port to connect to (default "7656")
+  -z    Allow zero-hop, non-anonymous tunnels(true or false)
+</code></p>
+
+<h3>build in docker</h3>
+
+<p><code>
+docker build --build-arg user=eephttpd -f Dockerfile -t eyedeekay/eephttpd .
+</code></p>
+
+<h3>Run in docker</h3>
+
+<p><code>
+docker run -i -t -d --network si \
+    --env samhost=sam-host \
+    --env samport=7656 \
+    --env args=-r # Additional arguments to pass to eephttpd\
+    --network-alias eephttpd \
+    --hostname eephttpd \
+    --name eephttpd \
+    --restart always \
+    --volume eephttpd:/home/eephttpd/ \
+    eyedeekay/eephttpd
+</code></p>