summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrian May <brian@linuxpenguins.xyz>2016-01-17 18:07:52 +1100
committerBrian May <brian@linuxpenguins.xyz>2016-01-17 18:07:52 +1100
commitc5af6fef8c310f3be603e294bc79bf81c05b3f2f (patch)
tree6ac15901624ed0f9540b5a8ae1ac33b4013cee53
parent6835183b373e595fd182bd27846ef32adeb0bc7a (diff)
Remove table.
Suspect it is causing sphinx to crash on readthedocs. See https://github.com/sphinx-doc/sphinx/issues/1871
-rw-r--r--docs/requirements.rst47
1 files changed, 35 insertions, 12 deletions
diff --git a/docs/requirements.rst b/docs/requirements.rst
index 3dab5f5..fae68cd 100644
--- a/docs/requirements.rst
+++ b/docs/requirements.rst
@@ -8,18 +8,29 @@ Client side Requirements
(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. |
-+-------+--------+------------+-----------------------------------------------+
+
+Linux with NAT method
+~~~~~~~~~~~~~~~~~~~~~
+Supports:
+
+* IPv4 TCP
+* IPv4 DNS
+
+Requires:
+
+* iptables DNAT, REDIRECT, and ttl modules.
+
+
+Linux with TPROXY method
+~~~~~~~~~~~~~~~~~~~~~~~~
+Supports:
+
+* IPv4 TCP
+* IPv4 UDP (requires ``recmsg`` - see below)
+* IPv6 DNS (requires ``recmsg`` - see below)
+* IPv6 TCP
+* IPv6 UDP (requires ``recmsg`` - see below)
+* IPv6 DNS (requires ``recmsg`` - see below)
.. _PyXAPI: http://www.pps.univ-paris-diderot.fr/~ylg/PyXAPI/
@@ -29,6 +40,18 @@ later. Under Python 2 you might find it sufficient installing PyXAPI_ to get
the ``recvmsg()`` function.
+MacOS with PF method
+~~~~~~~~~~~~~~~~~~~~
+Supports:
+
+* IPv4 TCP
+* IPv4 DNS
+
+Requires:
+
+* You need to have the pfctl command.
+
+
Server side Requirements
------------------------
Python 2.7 or Python 3.5.