From 1227ad3ac09cdcdb1349a35e9bff15ab38eeb2e4 Mon Sep 17 00:00:00 2001
From: Jeff Becker <jeff@i2p.rocks>
Date: Thu, 26 Mar 2020 16:10:35 -0400
Subject: [PATCH] add snapp options documentation

---
 docs/snap-config-options.md | 47 +++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 docs/snap-config-options.md

diff --git a/docs/snap-config-options.md b/docs/snap-config-options.md
new file mode 100644
index 000000000..0979fe22a
--- /dev/null
+++ b/docs/snap-config-options.md
@@ -0,0 +1,47 @@
+
+# snapp config options
+
+## required
+
+### ifname
+network interface name 
+### ifaddr
+ip range of network interface
+
+## optional
+
+### keyfile
+the private key to persist address with.
+if not specified the address will be ephemeral.
+### reachable
+bool value that sets if we publish our snapp to the dht
+`true`: we are reachable via dht
+`false`: we are not reachable via dht
+### hops
+number of hops in a path, min is `1`, max is `8`, defaults to `4`
+### paths
+number of paths to maintain at any given time, defaults to `6`.
+### blacklist-snode
+adds a `.snode` to path build blacklist
+### exit-node
+specify a `.snode` or `.loki` address to use as an exit broker
+### local-dns
+address to bind local dns resoler to, defaults to `127.3.2.1:53`
+if port is omitted it uses port `53`
+### upstream-dns
+address to forward non lokinet related queries to. if not set lokinet dns will reply with srvfail.
+### mapaddr
+perma map `.loki` address to an ip owned by the snapp
+to map `whatever.loki` to `10.0.10.10` it can be specified via:
+```
+mapaddr=whatever.loki:10.0.10.10
+```
+
+## compile time optional features
+
+### on-up
+path to shell script to call when our interface is up
+### on-down
+path to shell script to call when our interface is down
+### on-ready
+path to shell script to call when snapp is first ready