From 2559c264c6e0455f02d47204a97f32ee73b4fd63 Mon Sep 17 00:00:00 2001 From: Dan Guido Date: Tue, 7 Feb 2017 16:46:58 -0500 Subject: [PATCH] Slightly better docs --- CONTRIBUTING.md | 5 +++-- README.md | 6 ++---- docs/Troubleshooting.md | 8 ++++++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b5b936..314a5d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,14 @@ ### Troubleshooting -* Check that you installed all the dependencies with pip and have Ansible 2.1+ +* Check that all necessary dependencies are installed, including the correct version of Ansible * If installing to a local server, use a fresh install of Ubuntu 16.04 +* Check that your issue is not already described in the [troubleshooting](docs/TROUBLESHOOTING.md) docs ### Filing New Issues * Please review the [FAQ](https://github.com/trailofbits/algo#faq) * Please include the full output from your terminal window if appropriate -* We only support macOS 10.11 and newer +* We only support macOS 10.11+, Windows 8+, and Ubuntu 16.04+ ### Pull Requests diff --git a/README.md b/README.md index 6689abc..54335c0 100644 --- a/README.md +++ b/README.md @@ -125,8 +125,6 @@ OpenVPN does not have out-of-the-box client support on any major desktop or mobi Alpine Linux is not supported out-of-the-box by any major cloud provider. We are interested in supporting Free-, Open-, and HardenedBSD. Follow along or contribute to our BSD support in [this issue](https://github.com/trailofbits/algo/issues/35). -## [Troubleshooting](docs/Troubleshooting.md) +## [Troubleshooting](docs/TROUBLESHOOTING.md) -### Little Snitch is broken when connected to the VPN - -Little Snitch is not compatible with IPSEC VPNs due to a known bug in macOS and there is no solution. The Little Snitch "filter" does not get incoming packets from IPSEC VPNs and, therefore, cannot evaluate any rules over them. Their developers have filed a bug report with Apple but there has been no response. There is nothing they or Algo can do to resolve this problem on their own. You can read more about this problem in [issue #134](https://github.com/trailofbits/algo/issues/134). +If you have issues deploying and using the Algo VPN server, check the [troubleshooting](docs/TROUBLESHOOTING.md) documentation for solutions to common problems. \ No newline at end of file diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 33faf5a..3e4adf9 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -45,6 +45,10 @@ Storing debug log for failure in /Users/algore/Library/Logs/pip.log You are running an old version of `pip` that cannot build the `pycrypto` dependency. Upgrade to a new version of `pip` by running `sudo pip install -U pip`. -### Various parts of the internet appear to be offline through the VPN +### Little Snitch is broken when connected to the VPN -The issue may related to the MTU size, try to use `ping` with the don't fragment bit and various packet size in order to determine the MTU size for your network and set up this properly on the physical adapter. +Little Snitch is not compatible with IPSEC VPNs due to a known bug in macOS and there is no solution. The Little Snitch "filter" does not get incoming packets from IPSEC VPNs and, therefore, cannot evaluate any rules over them. Their developers have filed a bug report with Apple but there has been no response. There is nothing they or Algo can do to resolve this problem on their own. You can read more about this problem in [issue #134](https://github.com/trailofbits/algo/issues/134). + +### Various websites appear to be offline through the VPN + +This issue appears intermittently due to issues with MTU size. If you experience this issue, we recommend filing a ticket for assistance. Advanced users can troubleshoot the correct MTU size by retrying `ping` with the "don't fragment" bit size and decreasing packet size. This will determine the correct MTU size for your network, which you then need to update on your network adapter. \ No newline at end of file