Running the Gateway with Docker or pip

The Gateway accepts various arguments as described in the Startup Arguments section. Below are 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

172.17.0.1

node-public-key

(Ethereum only) Node ID of your Ethereum node. You can retrieve your node ID using the Ethereum rpc command admin.nodeInfo

50ff319…b35b76

private-ssl-base-url

(For Gateways using an Account) Location of the private Gateway certificate for accounts that registered and obtained private certificates. It can be a local or remote directory. The format is URI

file:///home/[user]/ssl/

Docker

You can run the Gateway as a Docker image.

Here is a basic way to run the Gateway on the Ethereum and Bitcoin Cash network as a daemon:

Ethereum (Without Account)
Ethereum (With Account)
Ethereum (Without Account)
docker run -d --name gateway -p 1801:1801 bloxroute/bxgateway:latest
--blockchain-protocol Ethereum --blockchain-ip 172.17.0.3
--blockchain-port 30303 --node-public-key="50ff319...b35b76"
Ethereum (With Account)
docker run -d --name gateway -p 1801:1801 --volume /home/ubuntu/ssl:/app/ssl
bloxroute/bxgateway:latest
--blockchain-protocol Ethereum --blockchain-ip 172.17.0.3
--blockchain-port 30303 --node-public-key="50ff319...b35b76"
--private-ssl-base-url file:///app/ssl

pip

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, to run a Gateway installed via a pip on the Ethereum network:

pip (Without Account)
pip (With Account)
pip (Without Account)
bloxroute-gateway --blockchain-protocol Ethereum --blockchain-ip 172.17.0.3
--blockchain-port 30303 --node-public-key="50ff319...b35b76"
> gateway.out
pip (With Account)
bloxroute-gateway --blockchain-protocol Ethereum --blockchain-ip 172.17.0.3
--blockchain-port 30303 --node-public-key="50ff319...b35b76"
--private-ssl-base-url file:///home/ubuntu/ssl
> gateway.out
Contents
Docker
pip