diff options
| author | Brian May <brian@linuxpenguins.xyz> | 2016-01-17 16:16:36 +1100 |
|---|---|---|
| committer | Brian May <brian@linuxpenguins.xyz> | 2016-01-17 16:19:13 +1100 |
| commit | 262affe94fff020aafddc3491c677a5b7853bf66 (patch) | |
| tree | f42b5eafecc4924e178fdfbc22e8d0f049c4396d /docs/requirements.rst | |
| parent | d80b590a71c48933969fe04190e748067561c8c3 (diff) | |
Use Sphinx for documentation
See #60
Diffstat (limited to 'docs/requirements.rst')
| -rw-r--r-- | docs/requirements.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/requirements.rst b/docs/requirements.rst new file mode 100644 index 0000000..cefdb96 --- /dev/null +++ b/docs/requirements.rst @@ -0,0 +1,35 @@ +Requirements +============ + +Client side Requirements +------------------------ + +- sudo, or root access on your client machine. + (The server doesn't need admin access.) +- Python 2.7 or Python 3.5. + ++-------+--------+------------+-----------------------------------------------+ +| OS | Method | Features | Requirements | ++=======+========+============+===============================================+ +| Linux | NAT | * IPv4 TCP + iptables DNAT, REDIRECT, and ttl modules. | ++ +--------+------------+-----------------------------------------------+ +| | TPROXY | * IPv4 TCP + Linux with TPROXY support. | +| | | * IPv4 UDP + Python 3.5 preferred (see below). | +| | | * IPv6 TCP + Python 2 may require PyXAPI_ (see below). | +| | | * IPv6 UDP + | ++-------+--------+------------+-----------------------------------------------+ +| MacOS | PF | * IPv4 TCP + You need to have the pfctl command. | ++-------+--------+------------+-----------------------------------------------+ + +.. _PyXAPI: http://www.pps.univ-paris-diderot.fr/~ylg/PyXAPI/ + +Server side Requirements +------------------------ +Python 2.7 or Python 3.5. + + +Additional Suggested Software +----------------------------- + +- You may want to use autossh, available in various package management + systems |