Sign inSign up

flarefoundation/go-flare

By flarefoundation

•Updated 2 months ago

The public container for Flare Mainnet, Coston2, Coston and Songbird networks.

Image
0

50K+

flarefoundation/go-flare repository overview

⁠Flare, Coston2, Coston and Songbird

Current stable tags: v1.12.0 and v1.12.0-dless-hotfix1 (distroless variant).

​ Docker image for the Flare, Coston2, Coston and Songbird node implementation found on github⁠.

⁠Quickstart

docker run -d -p 9650:9650 flarefoundation/go-flare:latest

Currently the default network is costwo but you can change that by providing a NETWORK_ID environment variable (i.e. NETWORK_ID=flare).

⁠Mounting storage

The three points of interest for mounting are:

NameDefault location
Database/app/db
Logging/app/logs
Configuration/app/conf

All of these may be changed using the environment variables.

docker run -d \
	-v /tmp/db:/app/db \
	-v /tmp/conf:/app/conf \
	-p 9650:9650 \
	-e AUTOCONFIGURE_BOOTSTRAP=1 \
	flarefoundation/go-flare:latest

When using distroless variant, make sure to chown all configs and storage location to UID 65532.

⁠Container Configuration

These are the environment variables you can edit and their default values:​

NameDefaultDescription
HTTP_HOST0.0.0.0The bind address of the service
HTTP_PORT9650The port on which the API is served
STAKING_PORT9651The staking port for bootstrapping nodes
PUBLIC_IP(empty)The public IP of the service
DB_DIR/app/dbThe database directory location
DB_TYPEleveldbThe database type to be used
BOOTSTRAP_IPS(empty)A list of bootstrap server ips; ref --bootstrap-ips-string⁠
BOOTSTRAP_IDS(empty)A list of bootstrap server ids; ref --bootstrap-ids-string⁠
CHAIN_CONFIG_DIR/app/confConfiguration directory
LOG_DIR/app/logsLogging directory
LOG_LEVELinfoLogging level
NETWORK_IDcostwoThe network id. The common ids are flare | costwo | coston | songbird
AUTOCONFIGURE_PUBLIC_IP0Set to 1 to autoconfigure PUBLIC_IP, skipped if PUBLIC_IP is set
AUTOCONFIGURE_BOOTSTRAP0Set to 1 to autoconfigure BOOTSTRAP_IPS and BOOTSTRAP_IDS
AUTOCONFIGURE_BOOTSTRAP_ENDPOINThttps://coston2-bootstrap.flare.network/ext/info or https://flare-bootstrap.flare.network/ext/info or https://coston-bootstrap.flare.network/ext/info or https://songbird-bootstrap.flare.network/ext/infoEndpoint used for bootstrapping⁠ when AUTOCONFIGURE_BOOTSTRAP is enabled.
EXTRA_ARGUMENTSExtra arguments passed to flare binary

⁠Node Configuration

The flare node can be configured by specifying your own configuration for the different chains but mainly the C (aka. Contract) chain. The specified configuration determines which capabilities the node has and it affects how the node has to be set up. We mainly distinguish between two standard configurations described below.

⁠External API configuration

The external API configuration is the relatively small set of functions that it exposes which are meant for public use. The node with this configuration exposes the HTTP port (default: 9650) and does not need any other open ports to work.

{
  "snowman-api-enabled": false,
  "coreth-admin-api-enabled": false,
  "coreth-admin-api-dir": "",
  "eth-apis": [
    "eth",
    "eth-filter",
    "net",
    "web3",
    "internal-eth",
    "internal-blockchain",
    "internal-transaction"
  ],
}
⁠Internal API configuration

Similarly to the external API configuration, this one also responds to API calls but has additional calls exposed that help with longer running tasks, debugging, tracing, etc. It is therefore NOT meant for public use and it should NOT be publicly accessible. The node with this configuration exposes the HTTP port (default: 9650) and does not need any other open ports to work.

{
  "snowman-api-enabled": false,
  "coreth-admin-api-enabled": false,
  "coreth-admin-api-dir": "",
  "eth-apis": [
    "eth",
    "eth-filter",
    "admin",
    "debug",
    "net",
    "debug-tracer",
    "web3",
    "internal-eth",
    "internal-blockchain",
    "internal-transaction",
    "internal-tx-pool",
    "internal-debug",
    "internal-account",
    "internal-personal"
  ],
}
⁠Additional information

Here's a list of helpful links for additional information about configuration:

Tag summary

Content type

Image

Digest

sha256:ddedcc668…

Size

256 Bytes

Last updated

2 months ago

docker pull flarefoundation/go-flare:sha256-bfe6f9f5a2e9ff044014003c5aaa123e7f16f8641d0b38ebcbf792921a080b27.sig