Skip to content

Commit

Permalink
add binary download instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
outerlook committed Aug 15, 2024
1 parent 7395068 commit be9ff09
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,31 @@ Before you begin, ensure you have the following:
1. **Kwil-admin**: Used to generate the initial configuration file.
- Download from the [latest GitHub release](https://github.com/kwilteam/kwil-db/releases)

<details><summary>Download with github-cli</summary>

```bash
# archs: linux_amd64, linux_arm64, darwin_amd64, darwin_arm64
MY_ARCH=
gh release download --repo kwilteam/kwil-db --pattern "kwil-db_*_$MY_ARCH.tar.gz"
```
</details>

2. **Docker**: Required for running the PostgreSQL image.
- Install from [Docker's official website](https://docs.docker.com/get-docker/)
3. **TSN Binaries**: Necessary for node deployment.
- Download from the [latest GitHub release](https://github.com/truflation/tsn-db/releases)
<details><summary>Download with github-cli</summary>
```bash
# gh needs to be authenticated, tsn is private
# archs: linux_amd64, linux_arm64, darwin_amd64, darwin_arm64
MY_ARCH=
gh release download --repo truflation/tsn --pattern "*kwild_$MY_ARCH.tar.gz"
```
</details>
## Setup Steps
### 1. Generate Initial Configuration
Expand Down Expand Up @@ -60,12 +79,12 @@ To upgrade your node to a validator:
kwil-admin validators join --rpcserver /path/to/your/node.sock
```

3. Wait for approval from existing validators. You can check your join request status with:
3. Wait for approval from existing validators. You can check your join request status with:

```bash
kwil-admin validators join-status <your-public-key> --rpcserver /path/to/your/node.sock
```

You can always ping us for help in the validator process.

### 5. Submit Your Node to Available Node List (Optional)
Expand Down

0 comments on commit be9ff09

Please sign in to comment.