Ethereum Network Intelligence API

https://github.com/zilliqa/eth-net-intelligence-api
Admin
Tokens:573
Snippets:2
Trust Score:9.5
License:GPL-3.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Deploy Zilliqa Stats Agent with Docker

Source: https://github.com/zilliqa/eth-net-intelligence-api/blob/main/README.md

This command deploys the Zilliqa Stats Agent as a Docker container, configuring it with essential environment variables for connecting to a Zilliqa node and the network status WebSocket server. It ensures the container restarts automatically unless stopped, providing a robust deployment solution.

```bash
docker run -td --restart=unless-stopped \
    --platform=linux/amd64 \
    --net=host \
    -e RPC_HOST="127.0.0.1" \
    -e RPC_PORT="4202" \
    -e LISTENING_PORT="3333" \
    -e INSTANCE_NAME="validator-name" \
    -e CONTACT_DETAILS="your email address" \
    -e WS_SERVER="ws://stats.zq2-protomainnet.zilliqa.com" \
    -e WS_SECRET="<secret-value>" \
    -e VERBOSITY="2" \
    <image-name>
```

--------------------------------

### Zilliqa Stats Agent Environment Variables Configuration

Source: https://github.com/zilliqa/eth-net-intelligence-api/blob/main/README.md

Detailed configuration options for the Zilliqa Stats Agent, specifying how to connect to the Zilliqa node's RPC interface and the public network status WebSocket server. These variables control network parameters, instance identification, contact details, and logging verbosity, enabling customization for different deployment scenarios.

```APIDOC
Environment Variables:

RPC_HOST (string, default: "127.0.0.1")
  - Description: The IP address of your Zilliqa node's RPC interface.

RPC_PORT (integer, default: 4202)
  - Description: The RPC admin port your Zilliqa node is listening on.

LISTENING_PORT (integer, default: 3333)
  - Description: The P2P communication port where the agent is listening.

INSTANCE_NAME (string)
  - Description: A unique name for your node instance (e.g., "validator-1").

CONTACT_DETAILS (string)
  - Description: Your contact email address for identification.

WS_SERVER (string)
  - Description: WebSocket server URL for the stats page.
  - Valid values:
    - "ws://stats.zq2-protomainnet.zilliqa.com" for protomainnet.
    - "ws://stats.zq2-prototestnet.zilliqa.com" for prototestnet.

WS_SECRET (string, sensitive)
  - Description: The secret token provided by Zilliqa. This is sensitive and confidential information. Please do not share it publicly or with unauthorized parties.

VERBOSITY (integer, default: 2)
  - Description: Logging verbosity level.
```
Tokens:
Raw