Skip to main content

Installation

The V3 Operator Service can be installed in several ways: as a binary, via Docker, deployed on Kubernetes with the Operator Helm Chart, or built from source. Choose your preferred method and follow the instructions below.

Binary Installation​

Download​

  1. Go to the releases page ↗ and find the latest version
  2. Select the binary file for your node's hardware
  3. Download and decompress the file
  4. Run commands from inside the v3-operator folder:
./operator COMMAND --flagA=123 --flagB=xyz
IconOptional Flags

The use of flags is optional.

Install Script (Linux and macOS)​

To install the latest release, run:

curl -sSfL https://raw.githubusercontent.com/stakewise/v3-operator/master/scripts/install.sh | sh -s

The binary will be placed in ~/bin. Add it to your PATH:

export PATH=$PATH:~/bin

To install a specific version to a custom location:

curl -sSfL https://raw.githubusercontent.com/stakewise/v3-operator/master/scripts/install.sh | sh -s -- -b <custom_location> vX.X.X

Run commands with:

operator COMMAND --flagA=123 --flagB=xyz

Configuration Options​

Environment Variables​

The V3 Operator Service can be configured via environment variables instead of CLI flags. This approach is particularly useful for containerized deployments.

IconEnvironment Configuration
  1. Copy the example file ↗ and save it as .env
  2. Adjust the configuration based on your node setup
  3. Load the environment variables before running the Operator Service:
export $(grep -v '^#' .env | xargs)

Verify variables are loaded correctly by running env.

Performance Optimization​

IconCPU Load Management

Use the --pool-size flag with both start and create-keys commands to control CPU usage:

  • Default: Uses 100% of available CPU cores
  • Recommended: Set to (number of CPU cores) / 2 to avoid impacting node performance
  • Example: --pool-size=4 for an 8-core system
./operator start --pool-size=4 --vault=0x000...

Gas Fee Management​

IconGas Cost Control

To mitigate excessive gas costs, use the --max-fee-per-gas-wei flag when starting the Operator Service:

./operator start --max-fee-per-gas-wei=50000000000 --vault=0x000...

This sets the maximum base fee you're willing to pay for validator registrations and vault harvests.

Verification​

After installation, verify your setup by running the version command:

./operator --version

Troubleshooting​

Common Issues​

IconPermission Issues

If you encounter permission errors:

  • Ensure the binary is executable: chmod +x ./operator
  • For Docker: Verify user ID mapping with -u $(id -u):$(id -g)
  • For source installs: Check Python and Poetry permissions
IconNetwork Connectivity

If the installation fails to download dependencies:

  • Check firewall and proxy settings
  • Verify internet connectivity to GitHub and package repositories
  • For Docker: Ensure Docker daemon is running and has internet access

Support​

For installation issues:

  • Check the GitHub Issues ↗
  • Review the troubleshooting documentation
  • Contact the StakeWise team via Discord or Telegram

Installation complete! Next, proceed with Key Cration →.

Last updated on