Installation Options

Users can run the bloXroute Local Gateway as a Docker container or use a local build based on the GitHub repository.

If you are running a blockchain node, to ensure that your Gateway will be able to connect to it, we recommended you add the Gateway as a trusted peer of your execution layer client.

After a successful installation, the will Gateway provide your node access to the BDN and will speed up block and transaction propagation to and from the node that it is peered with.

GitHub repository option

Pull the latest gateway version from our GitHub repository and install it locally.

GitHub - bloXroute-Labs/gatewayGitHub

Building the gateway requires using Go (version 1.19 or later). You can install it using your favorite package manager. Once the dependencies are installed, run make gateway.

Docker container option

To pull the latest gateway version, run the following command:

docker pull bloxroute/bloxroute-gateway-go:latest

Running your gateway

To run your gateway, copy the command below and modify it as needed.

A full list of start up arguments is available in the Startup Arguments page.

docker run --name bxgateway-go -d \
-v <LOG_FILE_PATH>:/app/bloxroute/logs \
-v <SSL_CERT_PATH>:/app/bloxroute/ssl \
-p 1801:1801 -p 28333:28333 bloxroute/bloxroute-gateway-go:latest \
--blockchain-network BSC-Mainnet \
--ws --port 1801 \
--enodes enode://<BLOCKCHAIN_NODE_PUBLIC_KEY>@<NODE_IP>:<NODE_PORT> \
--private-key <YOUR_PRIVATE_KEY> \
--eth-ws-uri ws://<ETH node IP address>:8546