From 99cafdd8479867c4e681c71ab1fb7e4e05d52a40 Mon Sep 17 00:00:00 2001 From: John-Mark Gurney Date: Fri, 25 Oct 2019 22:05:11 -0700 Subject: [PATCH] note that ntunnel uses 3.7, there are some asyncio features that ntunnel uses that weren't introduced till 3.7... note that it should be usable w/ TCP streams as well, though that feature is yet to be implemented... --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6530789..c2641b4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ ntunnel The ntunnel program is designed to tunnel Unix domain sockets over TCP, using the [Noise Protocol](https://noiseprotocol.org/). The goal is to -be secure and simple to use and setup. +be secure and simple to use and setup. Due to the flexibility, it can +forward any standard stream socket to another stream socket, including +TCP sockets. Example ------- @@ -36,14 +38,14 @@ the same text come out the other side. Running Tests ------------- -Currently this requires Python 3.x for some of the libraries. If the -default virtualenv is not 3.x, you can set the VIRTUALENV variable to -specify which one to use, such as: -`make env VIRTUALENV=virtualenv-3.6` +Currently ntunnel requires Python 3.7 or later. If the default +virtualenv is not 3.7 or later, you can set the VIRTUALENV variable to specify +which one to use, such as: +`make env VIRTUALENV=virtualenv-3.7` If you want to use an alternate version of python, you can specify VIRTUALENVARGS, such as: -`make env VIRTUALENV=virtualenv-3.6 VIRTUALENVARGS="-p $(which pypy3)"` +`make env VIRTUALENV=virtualenv-3.7 VIRTUALENVARGS="-p $(which pypy3)"` Note that I have not tested this w/ pypy3, as when compiling the cryptography libraries, it would pick the wrong ones, despite setting