Skip to content
This repository was archived by the owner on Jul 13, 2022. It is now read-only.

Commit 6b00049

Browse files
authored
Update install docs (#521)
1 parent 4a8a466 commit 6b00049

File tree

5 files changed

+22
-23
lines changed

5 files changed

+22
-23
lines changed

config/flags.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
var (
1212
ConfigFileFlag = &cli.StringFlag{
1313
Name: "config",
14-
Usage: "TOML configuration file",
14+
Usage: "JSON configuration file",
1515
}
1616

1717
VerbosityFlag = &cli.StringFlag{

docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ services:
99
container_name: bridge
1010
environment:
1111
- KEYSTORE_PASSWORD=password
12-
command: --config /config/config.toml
12+
command: --config /config/config.json
1313
volumes:
1414
- ./config:/config
1515
- ./keys:/keys/

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
[chainbridge](https://github.com/ChainSafe/ChainBridge)
1010

11-
A Modular Multi-Directional Blockchain Bridge to interact with Multiple Networks; Ethereum, Ethereum Classic, Substrate, Cosmos-SDK based chains.
11+
A Modular Multi-Directional Blockchain Bridge to interact with Multiple Networks.
1212
### Ethereum (Solidity)
1313

1414
[chainbridge-solidity](https://github.com/ChainSafe/chainbridge-solidity)

docs/installation.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,4 @@
1-
# Installation
2-
3-
## Docker
4-
5-
The official [ChainBridge Docker image](https://hub.docker.com/r/chainsafe/chainbridge)
6-
7-
To build the Docker image use
8-
9-
```
10-
docker build -t chainsafe/chainbridge .
11-
```
12-
13-
To start ChainBridge
14-
15-
```
16-
docker run -v ./config.toml:/config.toml chainsafe/chainbridge
17-
```
1+
# Installation```
182

193
## Dependencies
204

@@ -39,4 +23,19 @@ Use`go install` to add `chainbridge` to your GOBIN.
3923

4024
```
4125
make install
42-
```
26+
```
27+
28+
## Docker
29+
30+
The official ChainBridge Docker image can be found [here](https://hub.docker.com/r/chainsafe/chainbridge).
31+
32+
To build the Docker image locally run:
33+
34+
```
35+
docker build -t chainsafe/chainbridge .
36+
```
37+
38+
To start ChainBridge:
39+
40+
```
41+
docker run -v ./config.json:/config.json chainsafe/chainbridge

scripts/docker/start-docker.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ docker run -d -p 8545:8545 -p 8546:8546 chainbridge_ganache
1212

1313
dip=`ifconfig | grep 'inet 192'| awk '{ print $2}'`
1414

15-
sed "s/0.0.0.0/$dip/g" config.toml > docker.toml
15+
sed "s/0.0.0.0/$dip/g" config.json > docker.json
1616

17-
cp docker.toml config.toml
17+
cp docker.json config.json
1818

1919
docker build -f ./Docker/Bridge.Dockerfile -t 'chainbridge_bridge:latest' .
2020
docker run chainbridge_bridge

0 commit comments

Comments
 (0)