Installation
The Operator Service can be installed in several ways: as a binary, via Docker, or built from source. Choose your preferred method and follow the instructions below.
Vault Version Requirements
This guide is for Vault version 5 (Ethereum) or version 3 (Gnosis). Check the Prerequisites → section for details on checking your Vault version and instructions for older versions.
- Binary
- Docker Image
- Source Files
Download
- Go to the releases page ↗ and find the latest version
- Select the binary file for your node's hardware
- Download and decompress the file
- Run commands from inside the
v3-operator
folder:
./operator COMMAND --flagA=123 --flagB=xyz
Optional
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
Pull Official Image
docker pull europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v4.0.0
Build From Source
Alternatively, build the Docker image locally:
git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
docker build --pull -t europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v4.0.0 .
Run Commands
docker run --rm -ti \
-u $(id -u):$(id -g) \
-v ~/.stakewise/:/data \
europe-west4-docker.pkg.dev/stakewiselabs/public/v3-operator:v4.0.0 \
src/main.py COMMAND \
--flagA=123 \
--flagB=xyz
Optional
The use of flags is optional.
Configuration
When operating within Docker, it's necessary to specify the --data-dir
variable, such as --data-dir=/data
. Ensure the data-dir
is mapped to a directory on the host.
The database-dir
should also be mapped to a host directory or Docker volume, with write permissions enabled for the directory linked to database-dir
. Setting up permissions is not required if using volumes.
Requirements
Setup
git clone https://github.com/stakewise/v3-operator.git
cd v3-operator
poetry install --only main
Run Commands
Run commands from within the v3-operator
folder using the below format:
PYTHONPATH=. poetry run python src/main.py COMMAND --flagA=123 --flagB=xyz
Optional
The use of flags is optional.
Next Steps
Once installed, continue with Validator Keys →.