Skip to content

Commit 92a0ce2

Browse files
authored
docs: update docs for docker images and building v0.5.x (#61)
1 parent 30b9477 commit 92a0ce2

File tree

2 files changed

+72
-1
lines changed

2 files changed

+72
-1
lines changed

docs/docs/building.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,41 @@
44

55
- Go 1.14+ (installation instructions available [here](https://golang.org/dl/]))
66

7+
### Ubuntu
8+
9+
```bash
10+
# Run the following command if using Ubuntu
11+
sudo apt-get install libgmp-dev swig libboost-all-dev
12+
13+
# Download and install the MCL libraries
14+
cd ~
15+
wget https://github.com/herumi/mcl/archive/v1.05.tar.gz
16+
tar xvf v1.05.tar.gz
17+
cd mcl-1.05
18+
sudo make install
19+
sudo ldconfig
20+
```
21+
22+
### MacOS
23+
24+
```bash
25+
# Run the following command if using OS X
26+
brew install swig boost gmp
27+
28+
# Download and install the MCL libraries
29+
cd ~
30+
wget https://github.com/herumi/mcl/archive/v1.05.tar.gz
31+
tar xvf v1.05.tar.gz
32+
cd mcl-1.05
33+
sudo make install
34+
sudo ldconfig
35+
```
36+
737
## Building the code
838

939
Download the latest released version from github and build the project using the following commands:
1040

11-
git clone https://github.com/fetchai/fetchd.git -b release/v0.2.x && cd fetchd
41+
git clone https://github.com/fetchai/fetchd.git && cd fetchd
1242

1343
Then build the code with the command:
1444

docs/docs/docker-images.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,44 @@
33
For every Fetchd release a corresponding docker images is released. The full list of images and tags can be found at:
44

55
[https://hub.docker.com/r/fetchai/fetchd](https://hub.docker.com/r/fetchai/fetchd)
6+
7+
# Supported Tags & Dockerfiles
8+
9+
Current Versions:
10+
11+
* [0.5.2, 0.5](https://github.com/fetchai/fetchd/blob/v0.5.2/Dockerfile) (used for beaconworld test networks)
12+
* [0.2.7, 0.2](https://github.com/fetchai/fetchd/blob/v0.2.7/Dockerfile) (used for agentworld test networks)
13+
14+
# Quick Reference
15+
16+
* Support documentation available at the [Fetch.ai Documenation](https://docs.fetch.ai/)
17+
18+
* Where to file issues: [https://github.com/fetchai/fetchd/issues](https://github.com/fetchai/fetchd/issues)
19+
20+
* Maintained by: [The Fetch.ai Ledger Team](https://github.com/fetchai/fetchd)
21+
22+
* Supported architectures: amd64
23+
24+
# How to use this image
25+
26+
## Connecting to a test network
27+
28+
Connecting a node to the test network is easy. In its simpliest configuration the docker container can be run with just a couple of environment variables as shown below:
29+
30+
docker run -e MONIKER=<insert node name here> -e NETWORK=<network name> fetchai/fetchd:0.5
31+
32+
However, users will almost certainly want to mount a storage volume into the container so that the node does not need to resync from genesis everytime. This can be done by adding the following volume path:
33+
34+
docker run -e MONIKER=<insert node name here> -e NETWORK=<network name> -v /path/for/data:/root/.fetchd fetchai/fetchd:0.5
35+
36+
For example connecting a node to the beaconworld testnet can be done with the following command:
37+
38+
docker run -e MONIKER=my-first-fetch-node -e NETWORK=beaconworld -v $(pwd)/my-first-fetch-node-data:/root/.fetchd fetchai/fetchd:0.5
39+
40+
# License
41+
42+
View [license information](https://github.com/fetchai/fetchd/blob/master/LICENSE) for the software contained in this image.
43+
44+
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
45+
46+
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

0 commit comments

Comments
 (0)