Installation
This document outlines the different methods available for installing the Polygon Supernet binaries.
Supernets are rapidly evolving towards a production-ready state, and, as a result, instructions and concepts in these guides are subject to change.
Test releases include breaking changes and are not backward compatibility. Use the current test releases for testing and familiarization only.
It is highly recommended that reach out to the Supernets team for support.
To install and run Supernets, you have several options. The tabs below provide guides for each installation method. You can choose to use pre-built releases, a Docker image, or build from source.
We recommend using the pre-built releases and verifying the provided checksums for security.
The Docker image is also a convenient option for containerized deployment. Building from source provides greater flexibility, but requires a suitable development environment.
If you encounter any issues during the installation process, refer to the troubleshooting guide which will be available soon.
The latest stable test release is v1.0.0-rc1
- Pre-built releases
- Docker image
- Build from source
- Troubleshoot
To access the pre-built releases, visit the GitHub releases page. The client provides cross-compiled AMD64/ARM64 binaries for Darwin and Linux.
[For reference] Extract pre-release package
Extract the downloaded package using your file system's extraction tool or the provided commands below, and navigate to the pre-built release in your preferred interface or text editor.
- Linux
- Mac
- Windows
# replace <downloaded_package> with the actual package filename
tar -xzf <downloaded_package>
cd <downloaded_package>
# replace <downloaded_package> with the actual package filename
tar -xzf <downloaded_package>
cd <downloaded_package>
The tar command is available in PowerShell on Windows 10 (build 17063 or newer).
# replace <downloaded_package> with the actual package filename
tar -xzf <downloaded_package>
cd <downloaded_package>
For older Windows systems or Command Prompt, use third-party tools like 7-Zip or WinRAR, or the PowerShell cmdlet Expand-Archive.
# replace <downloaded_package> with the actual package filename
# replace <destination_folder> with the desired folder path for extracted files
Expand-Archive -Path <downloaded_package> -DestinationPath <destination_folder>
cd <destination_folder>
To use Docker, you will need to have it installed on your system. If you haven't already installed Docker, you can follow the instructions on the official Docker website for your operating system.
You can access the official Polygon Edge Docker images hosted under the 0xpolygon registry using the following command:
docker pull 0xpolygon/polygon-edge:latest
Before getting started, ensure you have Go installed on your system (version >= 1.15 and <= 1.19). Compatibility is being worked on for other versions and will be available in the near future.
To install Go, run the following command in your CLI (we are using 1.18 in this example):
sudo apt-get install golang-1.18. Or, use a package manager like Snapcraft for Linux, Homebrew for Mac, and Chocolatey for Windows.
Use the following commands to clone the Polygon Edge repository and build from source:
git clone https://github.com/0xPolygon/polygon-edge.git
cd polygon-edge/
go build -o polygon-edge .
Coming soon!