mirror of
https://github.com/logos-storage/logos-storage-docs.git
synced 2026-01-05 14:53:07 +00:00
Fixes and improvements to testnet guides (#37)
* fix windows quickstart guide * drop requirement to have git from both Windows and Linux/macOS guides * minor updates to the Linux/macOS testnet guide
This commit is contained in:
parent
e35ac6104d
commit
2172654eb5
@ -18,7 +18,7 @@ Please follow the steps for your OS from the list:
|
|||||||
|
|
||||||
1. Download binary and checksum for your platform/architecture
|
1. Download binary and checksum for your platform/architecture
|
||||||
```shell
|
```shell
|
||||||
version=v0.1.4
|
version=v0.1.5
|
||||||
platform=$(echo `uname -s` | awk '{print tolower($0)}')
|
platform=$(echo `uname -s` | awk '{print tolower($0)}')
|
||||||
architecture=$([[ `uname -m` == 'x86_64' ]] && echo amd64 || echo arm64)
|
architecture=$([[ `uname -m` == 'x86_64' ]] && echo amd64 || echo arm64)
|
||||||
|
|
||||||
@ -85,6 +85,10 @@ Please follow the steps for your OS from the list:
|
|||||||
1. Download binary and checksum for your platform/architecture
|
1. Download binary and checksum for your platform/architecture
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> For Windows, only amd64 architecture is supported now.
|
> For Windows, only amd64 architecture is supported now.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Windows antivirus software and built-in firewalls may cause steps to fail. We will cover some possible errors here, but always consider checking your setup if requests fail - in particular, if temporarily disabling your antivirus fixes it, then it is likely to be the culprit.
|
||||||
|
|
||||||
```batch
|
```batch
|
||||||
set version=v0.1.4
|
set version=v0.1.4
|
||||||
set platform=windows
|
set platform=windows
|
||||||
@ -97,6 +101,18 @@ Please follow the steps for your OS from the list:
|
|||||||
curl -LO https://github.com/codex-storage/nim-codex/releases/download/%version%/codex-%version%-%platform%-%architecture%-libs.zip.sha256
|
curl -LO https://github.com/codex-storage/nim-codex/releases/download/%version%/codex-%version%-%platform%-%architecture%-libs.zip.sha256
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you see an error like:
|
||||||
|
|
||||||
|
```batch
|
||||||
|
curl: (35) schannel: next InitializeSecurityContext failed: CRYPT_E_NO_REVOCATION_CHECK (0x80092012) - The revocation function was unable to check revocation for the certificate.
|
||||||
|
```
|
||||||
|
|
||||||
|
You may need to add the `--ssl-no-revoke` option to your curl calls, i.e., modify the calls above so they look like this:
|
||||||
|
|
||||||
|
```batch
|
||||||
|
curl -LO --ssl-no-revoke https://...
|
||||||
|
```
|
||||||
|
|
||||||
2. Verify checksum
|
2. Verify checksum
|
||||||
```batch
|
```batch
|
||||||
for /f "delims=" %a in ('certUtil -hashfile codex-%version%-%platform%-%architecture%-libs.zip SHA256 ^| findstr -vrc:"[^0123-9aAb-Cd-EfF ]"') do @set ACTUAL_HASH=%a
|
for /f "delims=" %a in ('certUtil -hashfile codex-%version%-%platform%-%architecture%-libs.zip SHA256 ^| findstr -vrc:"[^0123-9aAb-Cd-EfF ]"') do @set ACTUAL_HASH=%a
|
||||||
@ -120,10 +136,10 @@ Please follow the steps for your OS from the list:
|
|||||||
move /Y %LOCALAPPDATA%\Codex\codex-%version%-%platform%-%architecture%.exe %LOCALAPPDATA%\Codex\codex.exe
|
move /Y %LOCALAPPDATA%\Codex\codex-%version%-%platform%-%architecture%.exe %LOCALAPPDATA%\Codex\codex.exe
|
||||||
|
|
||||||
:: Add folder to the path permanently
|
:: Add folder to the path permanently
|
||||||
setx PATH %PATH%%LOCALAPPDATA%\Codex;
|
setx PATH "%PATH%%LOCALAPPDATA%\Codex;"
|
||||||
|
|
||||||
:: Add folder to the path for the current session
|
:: Add folder to the path for the current session
|
||||||
PATH %PATH%%LOCALAPPDATA%\Codex;
|
PATH "%PATH%%LOCALAPPDATA%\Codex;"
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Check the result
|
4. Check the result
|
||||||
@ -165,9 +181,13 @@ We may [run Codex in different modes](/learn/run#run), and for a quick start we
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Windows**
|
**Windows**
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Windows might at this stage prompt you to grant internet access to Codex. You must allow it for things to work.
|
||||||
|
|
||||||
```batch
|
```batch
|
||||||
:: Get Public IP
|
:: Get Public IP
|
||||||
for /f "delims=" %a in ('curl -s https://ip.codex.storage') do @set nat=%a
|
for /f "delims=" %a in ('curl -s --ssl-reqd ip.codex.storage') do @set nat=%a
|
||||||
|
|
||||||
:: Run
|
:: Run
|
||||||
codex ^
|
codex ^
|
||||||
|
|||||||
@ -3,33 +3,36 @@ outline: [2, 4]
|
|||||||
---
|
---
|
||||||
# Codex Testnet
|
# Codex Testnet
|
||||||
|
|
||||||
Codex Testnet was launched and ready to be used for testing.
|
The Codex Testnet has been launched and is ready to be used for testing.
|
||||||
|
|
||||||
Your participation in the Codex Testnet is subject to the [Codex Testnet Terms and Conditions](https://github.com/codex-storage/codex-testnet-starter/blob/master/Codex%20Testnet%20Terms%20and%20Conditions.pdf) and [Codex Testnet Privacy Policy](https://github.com/codex-storage/codex-testnet-starter/blob/master/Codex%20Testnet%20Privacy%20Policy.pdf).
|
Your participation in the Codex Testnet is subject to the [Codex Testnet Terms and Conditions](https://github.com/codex-storage/codex-testnet-starter/blob/master/Codex%20Testnet%20Terms%20and%20Conditions.pdf) and [Codex Testnet Privacy Policy](https://github.com/codex-storage/codex-testnet-starter/blob/master/Codex%20Testnet%20Privacy%20Policy.pdf).
|
||||||
|
|
||||||
|
**Guides.** We have basic guides covering how to set up a Storage Client which can be used to upload and persist files by buying storage in the Codex network. We recommend that you start with those.
|
||||||
|
|
||||||
We have several guides and you can use one more suitable for you
|
Running a Storage Provider is more involved and is covered as a separate guide which demonstrates the storage sales side, as well as how to run Codex with its own local Ethereum execution client.
|
||||||
- [Discord guide](#discord-guide)
|
|
||||||
- [Basic guide](#basic-guide)
|
Guides are available either on Discord, as step-by-step, interactive guides, or here as simple instructions that you can follow:
|
||||||
- [Advanced guide](#advanced-guide)
|
|
||||||
|
- **Basic: running a storage client.** [[Discord](#sc-guide-discord) | [web](#sc-guide-web)]
|
||||||
|
- **Advanced: Running a storage provider.** [[web](#sp-guide-web)]
|
||||||
|
|
||||||
|
The guides were tested on the following operating systems:
|
||||||
|
|
||||||
Guides were tested on the following OS:
|
|
||||||
- Linux: Ubuntu 24.04, Debian 12, Fedora 40
|
- Linux: Ubuntu 24.04, Debian 12, Fedora 40
|
||||||
- macOS: 15
|
- macOS: 15
|
||||||
- Windows: 11, Server 2022
|
- Windows: 11, Server 2022
|
||||||
|
|
||||||
## Discord guide
|
## Running a Storage Client (Discord Version) {#sc-guide-discord}
|
||||||
|
|
||||||
You can join [Codex Discord server](https://discord.gg/codex-storage) and jump into the [#:tv:|join-testnet](https://discord.com/channels/895609329053474826/1289923125928001702) channel.
|
You can join [Codex Discord server](https://discord.gg/codex-storage) and jump into the [#:tv:|join-testnet](https://discord.com/channels/895609329053474826/1289923125928001702) channel.
|
||||||
|
|
||||||
It is mostly the same as a [Basic guide](#basic-guide), but uses Discord capabilities to make a walk-through and you also can get a support in the [#:sos:|node-help](https://discord.com/channels/895609329053474826/1286205545837105224) channel.
|
It is mostly the same as a [Web guide](#sc-guide-web), but uses Discord capabilities so you can have an interactive, step-by-step guide, and you also can get a support in the [#:sos:|node-help](https://discord.com/channels/895609329053474826/1286205545837105224) channel.
|
||||||
|
|
||||||
## Basic guide
|
## Running a Storage Client (Web Version) {#sc-guide-web}
|
||||||
|
|
||||||
**Prerequisites**
|
**Prerequisites**
|
||||||
|
|
||||||
- [Git installed](https://git-scm.com/downloads)
|
- Access to your Internet router so you can [configure port forwarding](#basic-common)
|
||||||
- Configure port forwarding on your Internet router
|
|
||||||
|
|
||||||
Steps for [Linux/macOS](#basic-linux-macos) and [Windows](#basic-windows) are slightly different, so please use ones for your OS.
|
Steps for [Linux/macOS](#basic-linux-macos) and [Windows](#basic-windows) are slightly different, so please use ones for your OS.
|
||||||
|
|
||||||
@ -37,14 +40,16 @@ Steps for [Linux/macOS](#basic-linux-macos) and [Windows](#basic-windows) are sl
|
|||||||
|
|
||||||
### Linux/macOS {#basic-linux-macos}
|
### Linux/macOS {#basic-linux-macos}
|
||||||
|
|
||||||
1. Open console and clone the repository:
|
1. Download the master tarball from the Codex testnet starter repository, and untar its contents:
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/codex-storage/codex-testnet-starter
|
curl -LO https://github.com/codex-storage/codex-testnet-starter/archive/master.tar.gz
|
||||||
|
tar xzvf master.tar.gz
|
||||||
|
rm master.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Navigate to the scripts folder:
|
2. Navigate to the scripts folder:
|
||||||
```shell
|
```shell
|
||||||
cd codex-testnet-starter/scripts
|
cd codex-testnet-starter-master/scripts
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Install dependencies when required:
|
3. Install dependencies when required:
|
||||||
@ -80,14 +85,35 @@ Steps for [Linux/macOS](#basic-linux-macos) and [Windows](#basic-windows) are sl
|
|||||||
|
|
||||||
### Windows {#basic-windows}
|
### Windows {#basic-windows}
|
||||||
|
|
||||||
1. Open command prompt (`cmd`) and clone the repository:
|
1. Download the master tarball from the Codex testnet starter repository, and untar its contents:
|
||||||
|
> [!WARNING]
|
||||||
|
> Windows antivirus software and built-in firewalls may cause steps to fail. We will cover some possible errors here, but always consider checking your setup if requests fail - in particular, if temporarily disabling your antivirus fixes it, then it is likely to be the culprit.
|
||||||
|
|
||||||
```batch
|
```batch
|
||||||
git clone https://github.com/codex-storage/codex-testnet-starter
|
curl -LO https://github.com/codex-storage/codex-testnet-starter/archive/master.tar.gz
|
||||||
|
```
|
||||||
|
|
||||||
|
If you see an error like:
|
||||||
|
|
||||||
|
```batch
|
||||||
|
curl: (35) schannel: next InitializeSecurityContext failed: CRYPT_E_NO_REVOCATION_CHECK (0x80092012) - The revocation function was unable to check revocation for the certificate.
|
||||||
|
```
|
||||||
|
|
||||||
|
You may need to add the `--ssl-no-revoke` option to your curl call, e.g.:
|
||||||
|
|
||||||
|
```batch
|
||||||
|
curl -LO --ssl-no-revoke https://github.com/codex-storage/codex-testnet-starter/archive/master.tar.gz
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Extract the contents of the tar file, and then delete it:
|
||||||
|
```batch
|
||||||
|
tar xzvf master.tar.gz
|
||||||
|
del master.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Navigate to the scripts folder:
|
2. Navigate to the scripts folder:
|
||||||
```batch
|
```batch
|
||||||
cd codex-testnet-starter\scripts\windows
|
cd codex-testnet-starter-master\scripts\windows
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Download Codex binaries from GitHub releases:
|
3. Download Codex binaries from GitHub releases:
|
||||||
@ -129,13 +155,13 @@ You also can use [Codex App UI](https://app.codex.storage) to interact with your
|
|||||||
|
|
||||||
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](#troubleshooting).
|
||||||
|
|
||||||
## Advanced guide
|
## Running a Storage Provider (Web Version) {#sp-guide-web}
|
||||||
|
|
||||||
Work in progress :construction:
|
Work in progress :construction:
|
||||||
|
|
||||||
## Testnet data
|
## Testnet Data
|
||||||
|
|
||||||
### Bootstrap nodes
|
### Bootstrap Nodes
|
||||||
**Codex**
|
**Codex**
|
||||||
```shell
|
```shell
|
||||||
spr:CiUIAhIhAiJvIcA_ZwPZ9ugVKDbmqwhJZaig5zKyLiuaicRcCGqLEgIDARo8CicAJQgCEiECIm8hwD9nA9n26BUoNuarCEllqKDnMrIuK5qJxFwIaosQ3d6esAYaCwoJBJ_f8zKRAnU6KkYwRAIgM0MvWNJL296kJ9gWvfatfmVvT-A7O2s8Mxp8l9c8EW0CIC-h-H-jBVSgFjg3Eny2u33qF7BDnWFzo7fGfZ7_qc9P
|
spr:CiUIAhIhAiJvIcA_ZwPZ9ugVKDbmqwhJZaig5zKyLiuaicRcCGqLEgIDARo8CicAJQgCEiECIm8hwD9nA9n26BUoNuarCEllqKDnMrIuK5qJxFwIaosQ3d6esAYaCwoJBJ_f8zKRAnU6KkYwRAIgM0MvWNJL296kJ9gWvfatfmVvT-A7O2s8Mxp8l9c8EW0CIC-h-H-jBVSgFjg3Eny2u33qF7BDnWFzo7fGfZ7_qc9P
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user