How Can We Help?

Search for answers or browse our knowledge base.


Still need help? Ask our Service Desk!

Categories
< All Topics
Print

How to configure a Docker node

[[toc]]

Configure

::::: tip

Connect to the right network

:::: tabs

::: tab mainnet

In order to connect to the mainnet be sure to use one of the following configurations:

GNY_P2P_PEERS=/ip4/78.141.235.22/tcp/4097/p2p/QmdEmHir6AxNzHrhWBJ3PfUddRBabmmEGmdSaCenrKMCUh

:::

::: tab testnet

In order to connect to the testnet be sure to use one of the following configurations:

GNY_P2P_PEERS=/ip4/192.248.155.206/tcp/4097/p2p/QmUTkMvTdFsgNdtYMcN6U7VHBMzcVbg2oC3xYCagCJbRNs

:::

::::

:::::

Start Forging

::: warning
Do not reuse your delegate secret on different GNY Blockchain networks (localnet, testnet, mainnet). Otherwise you will make yourself vulnerable to replay attacks.
:::

::: tip
In order to start forging you need to first register as delegate. Be sure to checkout our Guides on how to register as delegate and how to create a random secret.
:::




In order to start forging please pass a secret or multiple secrets (comma separated) to the GNY Blockchain. This option is optional.

Change CLI arguments:

- npm run start
+ npm run start -- --secret="chief next globe deny try danger trust wet spoil away eight task"

Change your docker-compose.yml:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_SECRET=chief next globe deny try danger trust wet spoil away eight task

Configure Public IP

::: warning
The publicIp option is mandatory on the testnet and on the mainnet. If you don’t set it then the node will automatically use its privateIp which which will make the p2p communication with other nodes not work.
::::

Pass public ip as argument:

- npm run start
+ npm run start -- --publicIP="20.188.42.0"

Pass public ip as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_PUBLIC_IP=20.188.42.0

::: tip
After that the nodes own public ip configuration should be checked with the HTTP API endpoint /api/peers/info. This endpoint displays information about the own node!
:::

multiaddrs_publicIp_api_peers_info

Configure Network

The option network sets which network the node should connect to. This option is mandatory.

The network can be passed to the GNY node:

  • as argument --network=mainnet
  • as environment variable GNY_NETWORK=mainnet

:::: tabs

::: tab mainnet

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_NETWORK=mainnet

:::

::: tab testnet

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_NETWORK=testnet

:::

::: tab localnet

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_NETWORK=localnet

:::

::::

Configure P2P Secret




The p2p secret keeps the connection between peers secure. This is option is mandatory.

The p2p secret can be passed to the GNY node:

  • as argument: --privateP2PKey="CAASqQkwggSlAgEA..."
  • as environment variable: GNY_P2P_SECRET="CAASqQkwggSlAgEA..."

Pass p2p secret as argument:

- npm run start
+ npm run start -- --privateP2PKey="CAASqQkwggSlAgEA..."

Pass p2p secret as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_P2P_SECRET="CAASqQkwggSlAgEA..."

Configure P2P Peers

The p2p peers option says to which peer(s) (comma separated) we should connect in the network. This option is optional

The p2p peers option can be passed to the GNY node:

  • as argument: --peers="/ip4/192.248.155.206/tcp/4097/p2p/QmUTkMvTdFsgNdtYMcN6U7VHBMzcVbg2oC3xYCagCJbRNs"
  • as environment variable: GNY_P2P_PEERS=/ip4/192.248.155.206/tcp/4097/p2p/QmUTkMvTdFsgNdtYMcN6U7VHBMzcVbg2oC3xYCagCJbRNs

:::: tabs

::: tab mainnet

Pass p2p peers as argument:

- npm run start
+ npm run start -- --peers="/ip4/78.141.235.22/tcp/4097/p2p/QmdEmHir6AxNzHrhWBJ3PfUddRBabmmEGmdSaCenrKMCUh"

Pass p2p peers as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_P2P_PEERS=/ip4/78.141.235.22/tcp/4097/p2p/QmdEmHir6AxNzHrhWBJ3PfUddRBabmmEGmdSaCenrKMCUh

:::

::: tab testnet

Pass p2p peers as argument:

- npm run start
+ npm run start -- --peers="/ip4/192.248.155.206/tcp/4097/p2p/QmUTkMvTdFsgNdtYMcN6U7VHBMzcVbg2oC3xYCagCJbRNs"

Pass p2p peers as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+     - GNY_P2P_PEERS=/ip4/192.248.155.206/tcp/4097/p2p/QmUTkMvTdFsgNdtYMcN6U7VHBMzcVbg2oC3xYCagCJbRNs

:::

::::

Configure DB Password

The dbPassword option sets the password for the db to connect to.

The dbPassword option can be passed to the GNY node:

  • as argument: --dbPassword=docker
  • as environment variable: GNY_DB_PASSWORD=docker

Pass dbPassword as argument:

- npm run start
+ npm run start -- --dbPassword=docker

Pass dbPassword as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+    - GNY_DB_PASSWORD=docker

Configure DB Name

The dbDatabase configures the database name to which the GNY Blockchain should connect to.

The dbDatabase option can be passed to the GNY node:

  • as argument: --dbDatabase=postgres
  • as environment variable: GNY_DB_DATABASE=postgres

Pass dbDatabase as argument:

- npm run start
+ npm run start -- --dbDatabase=postgres

Pass dbDatabase as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+    - GNY_DB_DATABASE=postgres

Configure DB User

The dbUser sets the database user with which the GNY Blockchain should connect to.

The dbUser option can be passed to the GNY node:

  • as argument: --dbUser=postgres
  • as environment variable: GNY_DB_USER=postgres

Pass dbUser as argument:

- npm run start
+ npm run start -- --dbUser=postgres

Pass dbUser as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+    - GNY_DB_USER=postgres

Configure DB Host

The dbHost sets the database host to which the GNY Blockchain should connect to.

The dbHost option can be passed to the GNY node:

  • as argument: --dbHost=db1
  • as environment variable: GNY_DB_HOST=db1

Pass dbHost as argument:

- npm run start
+ npm run start -- --dbUser=db1

Pass dbHost as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+    - GNY_DB_HOST=db1

Configure DB Port

The dbPort sets the database port to which the GNY Blockchain should connect to.

The dbPort option can be passed to the GNY node:

  • as argument: --dbPort=5432
  • as environment variable: GNY_DB_PORT=5432

Pass dbPort as argument:

- npm run start
+ npm run start -- --dbPort=5432

Pass dbPort as environment variable:

services:
  # db1 service omitted
  node1:
    # other keys omitted
    environment:
+    - GNY_DB_Port=5432

All Environment Variable Options

All available Options

Options:
  -V, --version            output the version number
  --config <path>          Config file path
  --port <port>            Listening port number
  --address <ip>           Listening host name or ip
  --genesisblock <path>    Genesisblock path
  --peers [peers...]       Peers list
  --log <level>            Log level: log|trace|debug|info|warn|error|fatal
  --base <dir>             Base directory
  --privateP2PKey <key>    Private P2P Key (base64 encoded) - overrides p2p_key.json file
  --secret [secret...]     comma separated secrets
  --publicIP <ip>          Public IP of own server, default private IP
  --network <network>      Must be: localnet | testnet | mainnet
  --dbPassword <password>
  --dbDatabase <database>
  --dbUser <user>
  --dbHost <host>
  --dbPort <port>
  -h, --help               output usage information

Environment Variables:
  GNY_NETWORK=<network>       Must be: localnet | testnet | mainnet
  GNY_PORT=<port>             Listening port number
  GNY_LOG_LEVEL=<level>       log|trace|debug|info|warn|error|fatal
  GNY_P2P_SECRET=<key>        Private P2P Key (base64 encoded) - overrides p2p_key.json file
  GNY_SECRET=[secret...]      comma separated secrets
  GNY_PUBLIC_IP=<ip>          Public IP of own server, default private IP
  GNY_P2P_PEERS=[peers...]    comma separated peers
  GNY_ADDRESS=<address>       Listening host name or ip
  GNY_DB_PASSWORD=<password>  db password
  GNY_DB_DATABASE=<database>  db name
  GNY_DB_USER=<user>          db user
  GNY_DB_HOST=<host>          db host
  GNY_DB_PORT=<port>          db port
Was this article helpful?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Previous Docker GNY Nodes – Get Started
Next How to manage a Docker node
Table of Contents