Build from source

Prerequisites

• Java JDK

Important

Web3Signer requires Java 21 or later releases.

• Git or GitHub Desktop

Installation on Linux / Unix / macOS

Clone the Web3Signer repository

Clone the Consensys/web3signer repository:

git clone --recursive 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 --recursive 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