1. Home
  2. bloXroute Documentation
  3. Gateway Installation
  4. Running the Gateway

Running the Gateway

The Gateway accepts various arguments as described in the Arguments section. The table below includes the most-common arguments for the Gateway.

Parameter Description Example
blockchain-protocol Blockchain protocol of the blockchain node. Ethereum
blockchain-ip IP address of the blockchain node.
blockchain-network Blockchain network of the Blockchain node the Gateway will connect to. Unless otherwise instructed by bloXroute, this should be ‘Mainnet’. Mainnet
node-public-key (Ethereum only) Node ID of your ethereum node. You can retrieve your node ID using the ethereum rpc command admin.nodeInfo. N/A


Run the Docker as a daemon.

For example, to run on the Ethereum network:

docker run -d --name gateway -p 9001:9001 bloxroute/bxgateway:latest --blockchain-protocol Ethereum --blockchain-ip --blockchain-port 30303 --node-public-key=""

To run on the Bitcoin Cash network:

docker run -d --name gateway -p 9001:9001 bloxroute/bxgateway:latest --blockchain-protocol BitcoinCash --blockchain-ip --blockchain-port 8333


Run the Gateway by running the bloxroute_gateway command. It is recommended that you pipe the output to a log file (gateway.out below).

For example, on the Ethereum network:

bloxroute_gateway --blockchain-protocol Ethereum --blockchain-ip --blockchain-port 30303 --node-public-key="" > gateway.out

You may determine your node ID using the Ethereum Javascript console command admin.nodeInfo. The hexadecimal node ID is encoded in the username portion of the enode URL, separated from the host by an @ sign (For more, see https://github.com/ethereum/wiki/wiki/enode-url-format).

And on the Bitcoin network:

bloxroute_gateway --blockchain-protocol Bitcoin --blockchain-ip --blockchain-port 8333 > gateway.out

For additional information about Gateway arguments, users may pass the --help argument when starting the Gateway: bloxroute_gateway --help

How can we help?