Skip to content
This repository was archived by the owner on Apr 17, 2026. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions pages/docs/ecosystem-roles/relayer/running-relayer/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ curl -fsSL https://git.io/get-webb-relayer.sh | sh -s <version>
This will download the relayer binary (or update it if it already exists) and place it in your `$HOME/.webb` directory. The script
will also suggest adding the directory to your `PATH` environment variable.

For example, you may add the directory to your `PATH` as follows if you are using Bash. If you are using Zsh instead of Bash then replace .bashrc with .zshrc below.
```sh
echo 'export PATH="${HOME}/.webb:${PATH}"' >> ~/.bashrc
source ~/.bashrc
```

### Verify Installation

2. Verify that the relayer was installed successfully by running the following command:
Expand Down Expand Up @@ -72,6 +78,7 @@ To download the example configuration file, run the following command:
<Tab>

```sh filename="download" copy
mkdir -p ~/.config/webb-relayer
curl -fsSL https://raw.githubusercontent.com/webb-tools/relayer/main/config/example/config.toml -o ~/.config/webb-relayer/config.toml
```

Expand Down Expand Up @@ -106,16 +113,29 @@ export WEBB_PORT=9955

For our example configuration file, the following environment variables are required:

- `PRIVATE_KEY` - The private key of the relayer. This can be a hex-encoded private key or a mnemonic phrase.
- `PRIVATE_KEY` - The private key of the relayer. This is the hex-encoded private key. Use of the mnemonic phrase is not currently supported.

create a new file called `.env` in the same directory as your current directory and add the following line:
Create a new file called `.env` in the same directory as your current directory and add the following line:

```sh filename="PRIVATE_KEY" copy
# Hex-encoded private for the relayer (64 characters) prefixed with 0x
PRIVATE_KEY="0x..."
```

save the file and exit the editor.
Save the file and exit the editor.

Set the environment variable in current environment:

```sh
source ~/.config/webb-relayer/.env
```

Update your .bashrc or .zshrc file to set those environment variables each time you start a new terminal session:

```sh
echo 'source ~/.config/webb-relayer/.env' >> ~/.bashrc
```
Comment on lines +127 to +137
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is not necessary, as the relayer will try to find the .env file and load it for you.



## Running the Relayer

Expand Down