Browse Source

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...
tags/v0.1.0
John-Mark Gurney 5 years ago
parent
commit
99cafdd847
1 changed files with 8 additions and 6 deletions
  1. +8
    -6
      README.md

+ 8
- 6
README.md View File

@@ -3,7 +3,9 @@ ntunnel


The ntunnel program is designed to tunnel Unix domain sockets over TCP, The ntunnel program is designed to tunnel Unix domain sockets over TCP,
using the [Noise Protocol](https://noiseprotocol.org/). The goal is to 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 Example
------- -------
@@ -36,14 +38,14 @@ the same text come out the other side.
Running Tests 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 If you want to use an alternate version of python, you can specify
VIRTUALENVARGS, such as: 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 Note that I have not tested this w/ pypy3, as when compiling the
cryptography libraries, it would pick the wrong ones, despite setting cryptography libraries, it would pick the wrong ones, despite setting


Loading…
Cancel
Save