Skip to content

Latest commit

 

History

History
108 lines (59 loc) · 3.82 KB

README.md

File metadata and controls

108 lines (59 loc) · 3.82 KB

Substrate Telemetry DAppNode Package

Dappnode package metadata wrapper and docker image based on Substrate-telemetry from Parity Tech

  • This is the DAppNode Package Substrate Telemetry running frontend and eventually telemetry backend too. If you want to run only Telemetry backend install this DAppNode Package Substrate Telemetry Backend instead.

  • Frontend Telemetry Package connect to a local Telemetry backend include and started in this Package if the REMOTE_PUBLIC_IP_TELEMETRY_BACKEND in package env is not set (default).

  • Frontend Telemetry Package can connect to a remote standalone Telemetry backend Package be configuring REMOTE_PUBLIC_IP_TELEMETRY_BACKEND in package env.

  • Install latest release here of this DAppNode Package.

  • Polkadot Node can then target Substrate Telemetry by adding option :

--telemetry-url ws://BACKEND_PUBLIC_IP:8000/submit

It is an AragonApp whose repo is deployed at this address: 0x9f85ae5aefe4a3eff39d9a44212aae21dd15079a and whose ENS address is: substrate-telemetry-archipel.public.dappnode.eth

Configuration env parameters

Variable Description Values
REMOTE_PUBLIC_IP_TELEMETRY_BACKEND If not set (default mode), backend is started locally and automatically targeted. If the IP is set, the frontend target this IP backend and local telemetry backend service is not started. IP

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • git

    Install git commandline tool.

  • docker

    Install docker. The community edition (docker-ce) will work. In Linux make sure you grant permissions to the current user to use docker by adding current user to docker group, sudo usermod -aG docker $USER. Once you update the users group, exit from the current terminal and open a new one to make effect.

  • docker-compose

    Install docker-compose

Note: Make sure you can run git, docker ps, docker-compose without any issue and without sudo command.

No env parameters needed

Running

Start

$ docker-compose up -d

Stop

$ docker-compose down

Status

$ docker-compose ps

Logs

$ docker-compose logs -f

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Vladimir Ostapenco - Initial work - vladostp
  • Francois Branciard - Initial work - branciard

See also the list of contributors who participated in this project.

License

This project is licensed under GPL3 - see the LICENSE file for details

References

git

docker

docker-compose

DappNode