fix readme image names and remove network bit in docker-compose (#447)

* fix readme image names and remove network bit in docker-compose

* undo naff tweak
This commit is contained in:
James Wilson
2022-01-18 11:12:33 +00:00
committed by GitHub
parent c00cab33c9
commit b9f93242cd
2 changed files with 4 additions and 10 deletions
+4 -5
View File
@@ -131,7 +131,7 @@ If you'd like to get things running manually using Docker, you can do the follow
--name backend-core \
-p 8000:8000 \
--read-only \
substrate-telemetry-backend \
parity/substrate-telemetry-backend \
telemetry_core -l 0.0.0.0:8000
```
@@ -142,7 +142,7 @@ If you'd like to get things running manually using Docker, you can do the follow
--name backend-shard \
-p 8001:8001 \
--read-only \
substrate-telemetry-backend \
parity/substrate-telemetry-backend \
telemetry_shard -l 0.0.0.0:8001 -c http://backend-core:8000/shard_submit
```
@@ -152,15 +152,14 @@ If you'd like to get things running manually using Docker, you can do the follow
docker run --rm -it --network=telemetry \
--name frontend \
-p 3000:8000 \
--read-only \
-e SUBSTRATE_TELEMETRY_URL=ws://localhost:8000/feed \
substrate-telemetry-frontend
parity/substrate-telemetry-frontend
```
**NOTE:** Here we used `SUBSTRATE_TELEMETRY_URL=ws://localhost:8000/feed`. This will work if you test with everything running locally on your machine but NOT if your backend runs on a remote server. Keep in mind that the frontend docker image is serving a static site running your browser. The `SUBSTRATE_TELEMETRY_URL` is the WebSocket url that your browser will use to reach the backend. Say your backend runs on a remote server at `foo.example.com`, you will need to set the IP/url accordingly in `SUBSTRATE_TELEMETRY_URL` (in this case, to `ws://foo.example.com/feed`).
**NOTE:** Running the frontend container in *read-only* mode reduces attack surface that could be used to exploit
a container. It requires however a little more effort and mounting additionnal volumes as shown below:
a container. It requires however a little more effort and mounting additional volumes as shown below:
```
docker run --rm -it -p 80:8000 --name frontend \
-5
View File
@@ -1,10 +1,5 @@
version: "3"
networks:
default:
# Give the default network created below a sensible name:
name: substrate-telemetry
services:
telemetry-frontend:
build: