From fe73e03a41ec50962ffffcd588e9c462295f05d9 Mon Sep 17 00:00:00 2001 From: Ben Bierens <39762930+benbierens@users.noreply.github.com> Date: Thu, 17 Oct 2024 01:08:29 +0200 Subject: [PATCH] adds troubleshoot page (#42) * adds troubleshoot page * typo * Removes empty section, adjusts link. --- .vitepress/config.mts | 3 ++- learn/troubleshoot.md | 30 ++++++++++++++++++++++++++++++ networks/testnet.md | 6 +----- 3 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 learn/troubleshoot.md diff --git a/.vitepress/config.mts b/.vitepress/config.mts index c3f9fa7..dc3b587 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -103,7 +103,8 @@ export default withMermaid({ { text: 'Using Codex', link: '/learn/using' }, { text: 'Local Two Client Test', link: '/learn/local-two-client-test' }, { text: 'Local Marketplace', link: '/learn/local-marketplace' }, - { text: 'Download Flow', link: '/learn/download-flow' } + { text: 'Download Flow', link: '/learn/download-flow' }, + { text: 'Troubleshoot', link: '/learn/troubleshoot' } ] }, { diff --git a/learn/troubleshoot.md b/learn/troubleshoot.md new file mode 100644 index 0000000..a9e0eee --- /dev/null +++ b/learn/troubleshoot.md @@ -0,0 +1,30 @@ +--- +outline: [2, 3] +--- +# Troubleshoot + +Having trouble getting your Codex node connected to the testnet? Here's a list of common Codex connection conundrums and steps to diagnose and solve them. If your troubles are not addressed here, check our open issues on Github or reach out via our Discord server. + +## Some basics + +You've probably already considered these. But just in case: + +1. Are you using a VPN? Make sure it's configured correctly to forward the right ports, and make sure you announce your node by the public IP address where you can be reached. +1. Are you using a firewall or other security software? Make sure it's configured to allow incoming connections to Codex's discovery and peer-to-peer ports. + +## Check your announce address + +Your node announces your public address to the network, so other nodes can connect to you. A common issue is connection failure due to incorrect announce addresses. Follow these steps to check your announce address. + +1. Go to a whats-my-ip site, or `ip.codex.storage` and note the IP address. +1. Go into your router/modem WAN settings and find the public IP address. +1. These two addresses should match. +1. If they do not, it's possible that A) you're behind a VPN. In this case, it's up to you to disable the VPN or make sure all forwarding is configured correctly. or B) Your internet-service-provider has placed your uplink behind a secondary NAT. ISPs do this to save public IP addresses. The address assigned to your router/moderm is not a 'true' public internet address. Usually this issue can be solved by your ISP. Contact customer support and ask them to give you a public address (sometimes also called Dynamic IP address). +1. Call Codex's debug/info endpoint. See the [Using Codex](/learn/using) for the details. +1. In the JSON response, you'll find "announceAddresses". +1. The IP address listed there should match your public IP. +1. If the announce address in the JSON is incorrect, you can adjust it manually by changing Codex's CLI argument `--nat` or setting the environment variable `CODEX_NAT`. After you've changed your announce address and restarted your node, please allow some time (20-30mins) for the network to disseminate the updated address. + +If you've performed these steps and haven't found any issues, your announce address is probably not the problem. + + diff --git a/networks/testnet.md b/networks/testnet.md index dc18710..e693c39 100644 --- a/networks/testnet.md +++ b/networks/testnet.md @@ -153,7 +153,7 @@ After your node is up and running, you can use the [Codex API](/developers/api) You also can use [Codex App UI](https://app.codex.storage) to interact with your local Codex node. -Need help? Reach out to us in [#:sos:|node-help](https://discord.com/channels/895609329053474826/1286205545837105224) channel or check [troubleshooting guide](#troubleshooting). +Need help? Reach out to us in [#:sos:|node-help](https://discord.com/channels/895609329053474826/1286205545837105224) channel or check [troubleshooting guide](/learn/troubleshoot.md). ## Running a Storage Provider (Web Version) {#sp-guide-web} @@ -201,7 +201,3 @@ enode://6ba0e8b5d968ca8eb2650dd984cdcf50acc01e4ea182350e990191aadd79897801b79455 | 3 | Faucet ETH | [faucet-eth.testnet.codex.storage](https://faucet-eth.testnet.codex.storage) | | 4 | Faucet TST | [faucet-tst.testnet.codex.storage](https://faucet-tst.testnet.codex.storage) | | 5 | Status page | [status.testnet.codex.storage](https://status.testnet.codex.storage) | - -## Troubleshooting - -Work in progress :construction: