Skip to content

Commit c5af6fe

Browse files
committed
Remove table.
Suspect it is causing sphinx to crash on readthedocs. See sphinx-doc/sphinx#1871
1 parent 6835183 commit c5af6fe

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

docs/requirements.rst

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,29 @@ Client side Requirements
88
(The server doesn't need admin access.)
99
- Python 2.7 or Python 3.5.
1010

11-
+-------+--------+------------+-----------------------------------------------+
12-
| OS | Method | Features | Requirements |
13-
+=======+========+============+===============================================+
14-
| Linux | NAT | * IPv4 TCP + iptables DNAT, REDIRECT, and ttl modules. |
15-
+ +--------+------------+-----------------------------------------------+
16-
| | TPROXY | * IPv4 TCP + Linux with TPROXY support. |
17-
| | | * IPv4 UDP + Python 3.5 preferred (see below). |
18-
| | | * IPv6 TCP + Python 2 may require PyXAPI (see below). |
19-
| | | * IPv6 UDP + |
20-
+-------+--------+------------+-----------------------------------------------+
21-
| MacOS | PF | * IPv4 TCP + You need to have the pfctl command. |
22-
+-------+--------+------------+-----------------------------------------------+
11+
12+
Linux with NAT method
13+
~~~~~~~~~~~~~~~~~~~~~
14+
Supports:
15+
16+
* IPv4 TCP
17+
* IPv4 DNS
18+
19+
Requires:
20+
21+
* iptables DNAT, REDIRECT, and ttl modules.
22+
23+
24+
Linux with TPROXY method
25+
~~~~~~~~~~~~~~~~~~~~~~~~
26+
Supports:
27+
28+
* IPv4 TCP
29+
* IPv4 UDP (requires ``recmsg`` - see below)
30+
* IPv6 DNS (requires ``recmsg`` - see below)
31+
* IPv6 TCP
32+
* IPv6 UDP (requires ``recmsg`` - see below)
33+
* IPv6 DNS (requires ``recmsg`` - see below)
2334

2435
.. _PyXAPI: http://www.pps.univ-paris-diderot.fr/~ylg/PyXAPI/
2536

@@ -29,6 +40,18 @@ later. Under Python 2 you might find it sufficient installing PyXAPI_ to get
2940
the ``recvmsg()`` function.
3041

3142

43+
MacOS with PF method
44+
~~~~~~~~~~~~~~~~~~~~
45+
Supports:
46+
47+
* IPv4 TCP
48+
* IPv4 DNS
49+
50+
Requires:
51+
52+
* You need to have the pfctl command.
53+
54+
3255
Server side Requirements
3356
------------------------
3457
Python 2.7 or Python 3.5.

0 commit comments

Comments
 (0)