From 1be8bbed1c8f1682f0d433c9cf1113ffc486ffb6 Mon Sep 17 00:00:00 2001 From: Jeff Becker Date: Wed, 25 Apr 2018 10:09:09 -0400 Subject: [PATCH] more docs --- src/yggdrasil/config/i2p.go | 5 +++-- src/yggdrasil/config/tor.go | 12 +++++------- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/src/yggdrasil/config/i2p.go b/src/yggdrasil/config/i2p.go index 375d4131..0ee4a2b7 100644 --- a/src/yggdrasil/config/i2p.go +++ b/src/yggdrasil/config/i2p.go @@ -1,7 +1,8 @@ package config +// I2PConfig is the configuration structure for i2p related configuration type I2PConfig struct { - Keyfile string - Addr string + Keyfile string // private key file or empty string for ephemeral keys + Addr string // address of i2p api connector Enabled bool } diff --git a/src/yggdrasil/config/tor.go b/src/yggdrasil/config/tor.go index aceb885e..19f612d8 100644 --- a/src/yggdrasil/config/tor.go +++ b/src/yggdrasil/config/tor.go @@ -1,11 +1,9 @@ package config -/** -*tor specific configuration - */ +// TorConfig is the configuration structure for Tor Proxy related values type TorConfig struct { - OnionKeyfile string - SocksAddr string - UseForAll bool - Enabled bool + OnionKeyfile string // hidden service private key for ADD_ONION (currently unimplemented) + SocksAddr string // tor socks address + UseForAll bool // use tor proxy for all connections? + Enabled bool // use tor at all ? }