Skip to content

Commit

Permalink
Remove table.
Browse files Browse the repository at this point in the history
Suspect it is causing sphinx to crash on readthedocs. See
sphinx-doc/sphinx#1871
  • Loading branch information
brianmay committed Jan 17, 2016
1 parent 6835183 commit c5af6fe
Showing 1 changed file with 35 additions and 12 deletions.
47 changes: 35 additions & 12 deletions docs/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand All @@ -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.
Expand Down

0 comments on commit c5af6fe

Please sign in to comment.