[tor-commits] [chutney/master] Document CHUTNEY_LISTEN_ADDRESS in the README

[teor at torproject.org]

commit 70a3c679d8b95f702a5fbfe2091db452f47e16ea
Author: teor (Tim Wilson-Brown) <teor2345 at gmail.com>
Date:   Sat Jul 2 20:00:33 2016 +1000

    Document CHUTNEY_LISTEN_ADDRESS in the README
    
    Uses the text from the #18826 commit message, with modifications.
    Adds a note about IPv6, which is a work in progress.
---
 README | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README b/README
index 7b73157..44b23b3 100644
--- a/README
+++ b/README
@@ -59,6 +59,17 @@ HS Connection Tests:
   # Default behavior is one client connects to each HS
   ./chutney stop networks/hs-025
 
+Changing the network address:
+
+   Chutney defaults to binding to localhost. To change the bind address,
+   set the CHUTNEY_LISTEN_ADDRESS environment variable. Setting it to some
+   interface's IP address allows us to make the simulated Tor network
+   available on the network.
+
+   IPv6 support for both Tor and Chutney is a work in progress. If your system
+   returns IPv6 ::1 as the (first) address for localhost, you might need to
+   set CHUTNEY_LISTEN_ADDRESS="127.0.0.1" for chutney to work.
+
 The configuration files:
   networks/basic holds the configuration for the network you're configuring
   above.  It refers to some torrc template files in torrc_templates/.