diff --git a/.gitbook/assets/Screenshot 2023-08-02 at 16.40.02.png b/.gitbook/assets/Screenshot 2023-08-02 at 16.40.02.png new file mode 100644 index 0000000..5424ac3 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-08-02 at 16.40.02.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 5c1dec2..0d7adc7 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -80,5 +80,6 @@ * [FAQs](miscellaneous/faqs.md) * [Features](miscellaneous/feature-list-by-platform.md) -* [Troubleshooting](miscellaneous/troubleshooting.md) +* [Troubleshooting](miscellaneous/troubleshooting/README.md) + * [AnySync Netcheck Tool](miscellaneous/troubleshooting/anysync-netcheck-tool.md) * [Beta Migration](miscellaneous/migration-from-the-legacy-app.md) diff --git a/miscellaneous/troubleshooting.md b/miscellaneous/troubleshooting/README.md similarity index 100% rename from miscellaneous/troubleshooting.md rename to miscellaneous/troubleshooting/README.md diff --git a/miscellaneous/troubleshooting/anysync-netcheck-tool.md b/miscellaneous/troubleshooting/anysync-netcheck-tool.md new file mode 100644 index 0000000..ef0a745 --- /dev/null +++ b/miscellaneous/troubleshooting/anysync-netcheck-tool.md @@ -0,0 +1,47 @@ +# AnySync Netcheck Tool + +A simple tool that checks the ability to connect to Anytype nodes. It was created to test network and TLS (sync) issues. + +The _Netcheck_ Tool opens a connection to the coordinator nodes to establish communication with the libp2p protocol and _AnySync_ handshakes, to attempt to execute network configuration requests. + +*** + +### Download + +You can download the version for your OS here: + +{% embed url="https://github.com/anyproto/any-sync-tools/releases" %} + +The .zip contains all our tools, but the sync check procedure requires only **“any-sync-netcheck”**.\ +(The other file is our [self-hosting tool](https://github.com/anyproto/any-sync-tools/blob/main/any-sync-network/README.md).) + +### Installation + +**Build from source:** + +`go install github.com/anyproto/any-sync-tools/any-sync-netcheck@latest` + +*** + +#### Running The Tool + +Execute the file named: + +* `any-sync-netcheck` +* _or_ `any-sync-netcheck -v` for a verbose output + +*** + +#### Result + +* If your sync is **working as expected**, your output log should look something like this:\ + + +
+* **If the tool detects any errors:** please provide all details about your network setup, including VPN, proxy, firewalls, and antivirus. In this event, we may request you to run a trace-route or other system tools for further analysis later on. + +*** + +#### Send to Anyteam + +Send the resulting log and your network specs to [support@anytype.io](mailto:support@anytype.io).