Skip to content
You are reading Web3Signer development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Build from source

Prerequisites

Important

Web3Signer requires Java 11 or later releases.

Installation on Linux / Unix / macOS

Clone the Web3Signer Repository

Clone the Consensys/web3signer repository:

git clone https://github.com/Consensys/web3signer.git

Build Web3Signer

After cloning, go to the web3signer directory.

cd web3signer

Build Web3Signer with the Gradle wrapper gradlew:

./gradlew build

Go to the distribution directory:

cd build/distributions/

Expand the distribution archive:

tar -xzf web3signer-<version>.tar.gz

Move to the expanded folder and display the Web3Signer help to confirm installation.

cd web3signer-<version>/
bin/web3signer --help

Installation on Windows

Install Web3Signer

Clone the Consensys/web3signer repository:

git clone https://github.com/Consensys/web3signer.git

Build Web3Signer

Go to the web3signer directory:

cd web3signer

Build Web3Signer with the Gradle wrapper gradlew:

.\gradlew build

Note

To run gradlew, you must have the JAVA_HOME system variable set to the Java installation directory. For example: JAVA_HOME = C:\Program Files\Java\jdk1.8.0_181.

Go to the distribution directory:

cd build\distributions

Expand the distribution archive:

tar -xzf web3signer-<version>.tar.gz

Go to the expanded folder and display the Web3Signer help to confirm installation.

cd web3signer-<version>
bin\web3signer --help
Questions or feedback? You can discuss issues and obtain free support on Web3Signer Discord channel.
For paid professional support by Consensys, contact us at quorum@consensys.net.