Repository files navigation

Themaster branch by default on this repository is forAntelope/Spring@1.0.3. If you are looking for other versions like Leap or EOSIO, refer to the different version branches in the repository.

The usage of this repository makes use ofdocker anddocker-compose. This root docker container can be orchestrated into other platforms (Swarm, K8s, etc) as well so long as you understand how to deploy to them.

A quick guide on setting up docker and docker-compose can be found here.

Pull down this repository.

git clone https://github.com/greymass/docker-nodeos.gitcd docker-nodeos

To configure these containers, you'll first need to copy the example.env file into the root of the project. You can then change the variables in this file to impact both the building of the container as well as its startup.

cp configs/docker/default.env .env

This file contains the following parameters:

# The name of the network this environment is for (must be unique on the host machine)NETWORK_NAME=jungle# The port to expose the nodeos api(s) on the host machineNETWORK_PORT_API=8888# The port to expose the nodeos p2p procotol on the host machineNETWORK_PORT_P2P=9876# The git repository of the nodeos (EOSIO) repository to useNODEOS_REPOSITORY=https://github.com/AntelopeIO/spring.git# The branch/tag of nodeos to checkout during the build processNODEOS_VERSION=v1.0.3# A snapshot (compressed as tar.gz) to use during the startup of this nodeNODEOS_SNAPSHOT=https://snapshots.greymass.network/jungle/latest.tar.gz# Peers to inject into the nodeos configuration NODEOS_PEERS=peer.jungle3.alohaeos.com:9876 jungle.eosn.io:9876 jungle3.eosrio.io:58012

The second thing you'll need to configure is the nodeos configuration file itself. Create a copy of this configuration file as outlined below, and it'll be passed to the container for use.

cp configs/nodeos/example-minimal-api.config.ini configs/config.ini

This file is your standard nodeos configuration. More information is available on theofficial documentation.

During your first run and any time afterwards which you make changes to the configuration files, you'll need to rebuild the containers. Run the following command to kick off the build process.

docker-compose build

With the containers build, now you just need to run them.

docker-compose up -d

The nodeos instance within the container will bind to the ports on the host as defined in thedocker-compose.yaml file.

If you need to stop the container:

docker-compose down

A number of configurations have been setup for different methods of operation. Listed below are list of these configurations as well as the commands to quickly spin up that instance type.

This is the default configuration shown in the documentation above. This type of configuration launches one or more nodeos processes from a snapshot and load balances API requests between them. They also are configured to only keep 1 days worth of recent blocks and have the account query API enabled.

This API configuration is meant to serve out most requests, with the exception being they won't be able to serve out older blocks (v1/chain/get_block).

cp configs/docker/default.env .envcp configs/nodeos/example-minimal-api.config.ini configs/config.ini

Once copied, edit these configuration files (if needed).

If you had previously used thedocker-compose.override.yaml file for another configuration, clear that out.

git reset --hard docker-compose.override.yaml

Then build, and start it up:

docker-compose builddocker-compose up

The above configuration can also be used to scale up multiple API instances, which can be load balanced behind nginx. To use this configuration you'll need to copy the examplenginx.conf into place and make any modifications you may need.

cp configs/nginx/nginx.conf configs/nginx.conf

When starting, you'll just need to pass an extra parameter into thedocker-compose up command outlined in the previous example.

docker-compose builddocker-compose --profile nginx up

If you'd like to scale up to multiple instances, you'll use the--scale option in thedocker-compose up command.

docker-compose builddocker-compose --profile nginx up --scale nodeos=2

This configuration launches a single nodeos instance from a snapshot with only the p2p network enabled. This can be used as a p2p relay for multiple API node instances to prevent excess network chatter. Since it is launched from a snapshot it won't be useful in resyncing blocks to other nodes in the p2p network.

To use this repository to setup one of these instances, copy and modify the configuration for nodeos. Perform these commands from the root directly of the repository:

cp configs/docker/default.env .envcp configs/nodeos/example-minimal-p2p.config.ini configs/config.ini

Once copied, edit these configuration files (if needed).

Then modify thedocker-compose.override.yaml file to contain the following information:

version:'3.6'services:nodeos:extends:file:./configs/docker/nodeos-minimal-p2p.yamlservice:nodeos

Then build, and start it up:

docker-compose builddocker-compose up

docker-compose exec nginx nginx -s reload

Alogging.json file can now be added to the./configs folder of the project to create a custom nodeos logging configuration.

The file placed in this location will be included during the build process and used as nodeos starts up.

With this docker configuration designed to be scalable to multiple instances, a simplelogging.json copy into theconfigs folder won't be able to identify individual containers.

For this reason, you can now input those values into the.env file:

# Remote Logging - EndpointNODEOS_LOGGING_ENDPOINT=www.your.server.com:12201# Remote Logging - Operator NameNODEOS_LOGGING_OPERATOR=operator_name# Remote Logging - Network NameNODEOS_LOGGING_NETWORK=jungle4

When these values are found in the.env file, the initialization process of each container will modify thelogging.json file to inject values relevant to each container. The resulting output will be similar to:

{    "name": "net",    "type": "gelf",    "args": {        "endpoint": "NODEOS_LOGGING_ENDPOINT",        "host": "${NETWORK}${HOSTNAME}",        "_operator": "NODEOS_LOGGING_OPERATOR",        "_network": "NODEOS_LOGGING_NETWORK"    },    "enabled": false}