-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Documentation] Add poktrolld release binaries (#539)
Co-authored-by: Daniel Olshansky <[email protected]>
- Loading branch information
Showing
3 changed files
with
67 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
title: Installation | ||
sidebar_position: 0 | ||
--- | ||
|
||
- [Release binaries](#release-binaries) | ||
- [Installing from source](#installing-from-source) | ||
- [Prerequisites](#prerequisites) | ||
- [Homebrew and pkgx](#homebrew-and-pkgx) | ||
- [Windows Users](#windows-users) | ||
|
||
## Release binaries | ||
|
||
Pre-built binaries are available on our [releases page](https://github.com/pokt-network/poktroll/releases). | ||
|
||
The following snippet downloads/upgrades the binary to the latest released version (Linux and macOS only): | ||
|
||
```bash | ||
# Download the correct binary based on the OS and architecture | ||
curl -LO "https://github.com/pokt-network/poktroll/releases/latest/download/poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | ||
|
||
# Extract the downloaded tarball to /usr/local/bin | ||
sudo tar -zxf "poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" -C /usr/local/bin | ||
|
||
# Make the binary executable | ||
sudo chmod +x /usr/local/bin/poktrolld | ||
|
||
# Check version | ||
poktrolld version | ||
``` | ||
|
||
## Installing from source | ||
|
||
### Prerequisites | ||
|
||
Ensure you have the following installed: | ||
|
||
- [Go](https://go.dev/doc/install) (version 1.18 or later) | ||
- [Ignite CLI](https://docs.ignite.com/welcome/install) | ||
|
||
```bash | ||
git clone https://github.com/pokt-network/poktroll.git | ||
cd poktroll | ||
make go_develop | ||
make ignite_poktrolld_build | ||
``` | ||
|
||
Verify it worked by running: | ||
|
||
```bash | ||
poktrolld --help | ||
``` | ||
|
||
## Homebrew and pkgx | ||
|
||
:::tip | ||
We have an [open GitHub issue](https://github.com/pokt-network/poktroll/issues/535) | ||
to introduce `poktrolld` to [brew](https://brew.sh/) and [pkgx](https://github.com/pkgxdev/pkgx). | ||
|
||
Please reach out to us in the ticket if you want to pick this ticket! | ||
::: | ||
|
||
## Windows Users | ||
|
||
Currently, we do not support native Windows installation. Windows users are encouraged | ||
to use [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install) | ||
and follow the Linux installation instructions. |