summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorScott Kuhl <kuhl@mtu.edu>2021-06-02 14:10:41 -0400
committerScott Kuhl <kuhl@mtu.edu>2021-06-02 15:22:04 -0400
commit560c6b4ce87df8513831d8ad352c524f48b192b3 (patch)
treecd54611909bd7811a532cc2db6e0f60d918c1c3c /docs
parenta3cbf0885f8d5fdb2e611ec3383be206fc23464b (diff)
Improve hostwatch robustness and documentation.
If an exception occurs in hostwatch, sshuttle exits. Problems read/writing the ~/.sshuttle.hosts cache file on the remote machine would therefore cause sshuttle to exit. With this patch, we simply continue running without writing/reading the cache file in the remote home directory. This serves as an alternate fix for pull request #322 which proposed storing the cache file elsewhere. A list of included changes: - If we can't read or write the host cache file on the server, continue running. Hosts can be collected through the netstat, /etc/hosts, etc and the information can be reconstructed each run if a cache file isn't available to read. We write a log() message when this occurs. - Add additional types of exceptions to handle. - Continue even if we cannot read /etc/hosts on the server. - Update man page to mention the cache file on the remote host. - Indicate that messages are related to remote host instead of local host. - Add comments and descriptions to the code.
Diffstat (limited to 'docs')
-rw-r--r--docs/manpage.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/manpage.rst b/docs/manpage.rst
index ead9a16..8770235 100644
--- a/docs/manpage.rst
+++ b/docs/manpage.rst
@@ -89,6 +89,13 @@ Options
few subnets over the VPN, you probably would prefer to
keep using your local DNS server for everything else.
+ :program:`sshuttle` tries to store a cache of the hostnames in
+ ~/.sshuttle.hosts on the remote host. Similarly, it tries to read
+ the file when you later reconnect to the host with --auto-hosts
+ enabled to quickly populate the host list. When troubleshooting
+ this feature, try removing this file on the remote host when
+ sshuttle is not running.
+
.. option:: -N, --auto-nets
In addition to the subnets provided on the command
@@ -178,7 +185,7 @@ Options
A comma-separated list of hostnames to use to
initialize the :option:`--auto-hosts` scan algorithm.
- :option:`--auto-hosts` does things like poll local SMB servers
+ :option:`--auto-hosts` does things like poll netstat output
for lists of local hostnames, but can speed things up
if you use this option to give it a few names to start
from.