pezkuwichain/pezkuwi-telemetry
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-telemetry.git synced 2026-04-22 05:38:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix the doc according to the recent changes (#250)

Browse Source
This commit is contained in:
Chevdor
2020-04-17 22:05:59 +02:00
committed by GitHub
parent 00d21ef16c
commit d03679a78a
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -15
View File
@@ -1,5 +1,11 @@
# Polkadot Telemetry
## Overview
This repository contains both the backend ingestion server for Substrate Telemetry as well as the Frontend you typically see running at [telemetry.polkadot.io](https://telemetry.polkadot.io/).
The backend is a Rust project and the frontend is React/Typescript project.
## Getting Started
To run the backend, you will need `cargo` to build the binary. We recommend using [`rustup`](https://rustup.rs/).
@@ -16,22 +22,16 @@ yarn
```
cd backend
cargo build --release
./target/release/telemetry
./target/release/telemetry --help
```
By default, telemetry will listen on the local interface only (127.0.0.1) on port 8000. You may change both those values:
Use another port:
By default, telemetry will listen on the local interface only (127.0.0.1) on port 8000. You may change both those values with the `--listen` flag as shown below:
```
PORT=8123 telemetry
telemetry --listen 0.0.0.0:8888
```
You may also change the the listening interface. This is especially required if you are using docker:
```
BIND=0.0.0.0 telemetry
```
This example listen on all interfaces and on port :8888
### Terminal 2 - Frontend
@@ -46,17 +46,19 @@ yarn start
Follow up installation instructions from the [Polkadot repo](https://github.com/paritytech/polkadot)
```sh
./target/release/polkadot --dev --telemetry-url ws://localhost:8000/submit
polkadot --dev --telemetry-url ws://localhost:8000/submit
```
### Run via Docker
To run via docker make sure that you have Docker Desktop
- If you don't you can download for you OS here [Docker Desktop](https://www.docker.com/products/docker-desktop)
```
To run via docker make sure that you have Docker Desktop.
If you don't you can download for you OS here [Docker Desktop](https://www.docker.com/products/docker-desktop)
```sh
docker-compose up --build -d
```
- `-d` stands for detach, if you would like to see logs I recommend using [Kitmatic](https://kitematic.com/) or don't use the -d
- `-d` stands for detach, if you would like to see logs I recommend using [Kitmatic](https://kitematic.com/) or don't use the -d
- `--build` will build the images and rebuild, but this is not required every time
- If you want to makes UI changes, there is no need to rebuild the image as the files are being copied in via volumes.