From c5af6fef8c310f3be603e294bc79bf81c05b3f2f Mon Sep 17 00:00:00 2001 From: Brian May Date: Sun, 17 Jan 2016 18:07:52 +1100 Subject: [PATCH] Remove table. Suspect it is causing sphinx to crash on readthedocs. See https://github.com/sphinx-doc/sphinx/issues/1871 --- docs/requirements.rst | 47 ++++++++++++++++++++++++++++++++----------- 1 file 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.