summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)Author
2019-12-13Auto sudoers file (#269)William Mantly
* added sudoers options to command line arguments * added sudoers options to command line arguments * template for sudoers file * Added option for GUI sudo * added support for GUI sudo * script for auto adding sudo file * sudoers auto add works and validates * small change * Clean up for CI * removed code that belongs in another PR * added path for package bins * added sudoers bin * added sudoers-add to setup file * fixed issue with sudoers bash script * auto sudoers now works * added --sudoers-no-modify option * bin now works with ./run * removed debug print * Updated sudoers-add script * Fixed error passing sudoers config to script * more dynamic building of sudoers file * added option to specify sudoers.d file name * fixed indent issue * fixed indent issue * indent issue * clean up * formating * docs * fix for flags * Update usage.rst * removed shell=true * cleared CI errors * cleared CI errors * removed random * cleared linter issue * cleared linter issue * cleared linter issue * updated sudoers-add script * safer temp file * moved bin directory * moved bin directory * removed print * fixed spacing issue * sudoers commands must only containe upper case latters
2019-11-08Add option for latency control buffer sizeJoseph Barker
This commit resolves #297, allowing the buffers used in the latency control to be changed with a command line option ‘--latency-buffer-size’. We do this by changing a module variable in ssnet.py (similar to the MAX_CHANNEL variable) which seems to be the simplest code change without extensive hacking. Documentation is also updated.
2019-09-22docs: openwrtunl89
2018-12-29docs: document --ns-hosts --to-ns and update --dnsAndré Draszik
--ns-hosts is available since commit d2ee34d71c0e ("dns: Added --ns-hosts to tunnel only some requests") (released as v0.72), but was never documented. --to-ns is available since commit be559fc78b88 ("Fix case where there is no --dns.") after several bugfixes, released as v0.78.4, but was never documented.
2018-12-03Fix typo in docsDavid Landry
2018-11-29Document --version optionTodor Gaidarov
2018-08-25works on ChromeOS with Crostini VM (#262)tony godshall
* works on ChromeOS with Crostini VM tested on ASUS C101PA on Dev channel, should also work on Intel machines and Beta channel * crostini doc, and a note about xterms and VNC tested on ASUS C101PA on Dev channel, should also work on Intel machines and Beta channel
2018-06-29Doc UpdateDavid Patino
Remove reference to autossh per https://github.com/sshuttle/sshuttle/issues/143
2018-06-07Doc: Fix typoBenedikt Waldvogel
2018-06-03Doc: Improve Systemd service recommendation (fixes #238)desbma
2018-02-15Adds 'cd sshuttle' after 'git' to README and docsPetr Blaho
2018-01-30Documentation for loading options from configuration filevieira
2017-07-09Get version for sphinx from sshuttle.versionBrian May
2017-07-09Fix error in requirements.rstBrian May
2017-05-07Adds support for tunneling specific port ranges (#144)João Vieira
* Adds support for tunneling specific port ranges This set of changes implements the ability of specifying a port or port range for an IP or subnet to only tunnel those ports for that subnet. Also supports excluding a port or port range for a given IP or subnet. When, for a given subnet, there are intercepting ranges being added and excluded, the most specific, i.e., smaller range, takes precedence. In case of a tie the exclusion wins. For different subnets, the most specific, i.e., largest swidth, takes precedence independent of any eventual port ranges. Examples: Tunnels all traffic to the 188.0.0.0/8 subnet except those to port 443. ``` sshuttle -r <server> 188.0.0.0/8 -x 188.0.0.0/8:443 ``` Only tunnels traffic to port 80 of the 188.0.0.0/8 subnet. ``` sshuttle -r <server> 188.0.0.0/8:80 ``` Tunnels traffic to the 188.0.0.0/8 subnet and the port range that goes from 80 to 89. ``` sshuttle -r <server> 188.0.0.0/8:80-89 -x 188.0.0.0/8:80-90 ``` * Allow subnets to be specified with domain names Simplifies the implementation of address parsing by using socket.getaddrinfo(), which can handle domain resolution, IPv4 and IPv6 addresses. This was proposed and mostly implemented by @DavidBuchanan314 in #146. Signed-off-by: David Buchanan <DavidBuchanan314@users.noreply.github.com> Signed-off-by: João Vieira <vieira@yubo.be> * Also use getaddrinfo for parsing listen addr:port * Fixes tests for tunneling a port range * Updates documentation to include port/port range Adds some examples with subnet:port and subnet:port-port. Also clarifies the versions of Python supported on the server while maintaining the recommendation for Python 2.7, 3.5 or later. Mentions support for pfSense. * In Py2 only named arguments may follow *expression Fixes issue in Python 2.7 where *expression may only be followed by named arguments. * Use right regex to extract ip4/6, mask and ports * Tests for parse_subnetport
2016-10-30Fix punctuation and explain Type=notifyvieira
Added missing full stops and explain that Type=notify is needed in the systemd service unit.
2016-10-30Tests and documentation for systemd integrationvieira
Some tests and documentation for the systemd notification feature. Also fixes some corner case issues detected while writing the tests.
2016-09-04requirements.rst: Fix mistakesRichard Hartmann
2016-05-02tweak docs to match @vieira's changesDan Lenski
2016-04-30Fix PEP8 issuesBrian May
2016-04-18Attempt readthedocs workaroundBrian May
readthedocs alters docs/conf.py which in turn means python_scm detects a version and incorrectly adjusts the version number. Here we try to work around this problem. We do this by renaming the docs/conf.py file and copying it back to docs/conf.py when setup.py is invoked. This way, hopefully, scm won't see the changes to docs/conf.py References: http://stackoverflow.com/questions/35811267/readthedocs-and-setuptools-scm-version-wrong/36386177 https://github.com/pypa/setuptools_scm/issues/84
2016-04-08Revert "Test for RTD"Brian May
This reverts commit 7ea2d973c7baf2aa6e9920b8b87c68f32884cf4a.
2016-04-06Test for RTDBrian May
2016-04-03Backward compatibility with Python 2.4 (server)vieira
It is often the case that the user has no administrative control over the server that is being used. As such it is important to support as many versions as possible, at least on the remote server end. These fixes will allow sshuttle to be used with servers that have only python 2.4 or python 2.6 installed while hopefully not breaking the compatibility with 2.7 and 3.5.
2016-03-03Prepare documentation for releaseBrian May
2016-03-03Add date and version to docsBrian May
2016-01-21Remove references to number of yearsVeljko Tornjanski
Closes: #65
2016-01-21Fix description of excludes in Windows setupKS Chan
And some subtle grammar. Closes: #66
2016-01-20Update usage documentationBrian May
2016-01-20Add Windows documentationBrian May
Copied from https://coderwall.com/p/adfxgw/sshuttle-on-windows Closes #64
2016-01-17Update documentationBrian May
Closes #60.
2016-01-17Remove table.Brian May
Suspect it is causing sphinx to crash on readthedocs. See https://github.com/sphinx-doc/sphinx/issues/1871
2016-01-17Attempt work around of sphinx bugBrian May
2016-01-17Move recvmsg to requirementsBrian May
2016-01-17Remove coverageBrian May
Not required as we are not documenting the source code.
2016-01-17Fix broken link.Brian May
2016-01-17Add changelog to documentationBrian May
2016-01-17Use Sphinx for documentationBrian May
See #60