From 80da1aff8a1d6e5ea800ba4d3a50fa65823d6b34 Mon Sep 17 00:00:00 2001 From: CyMule1 Date: Sun, 12 Feb 2023 13:05:34 -0500 Subject: [PATCH 1/6] Add documentation for using network_mode: "host" Closes #381 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 4d4e9e0..7cd67e2 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ - [The unchained index](#the-unchained-index) - [Data science](#data-science) - [Quick Alternative Method to Start the Container](#quick-alternative-method-to-start-the-container) +- [Troubleshooting](#troubleshooting) - [Other](#other) ## Introduction @@ -166,6 +167,29 @@ Unchained index files externally, or if you want to quickly try out chifra. docker compose -f docker-compose.yml -f docker-compose.volume-override.yml up ``` +## Troubleshooting + +If you are running your RPC directly on your host machine (and not within another docker container) you may get the message: + +``` +Could not load RPC provider: Post "http://localhost:8545": dial tcp 127.0.0.1:8545: connect: connection refused +``` + +Make docker use your host network by adding `network_mode: "host"` to your `docker-compose.yml`: + +```yml + volumes: + - type: bind + # The source should match the folder you made to store the cache + source: /Users/user/Data/docker/cache + target: /cache + - type: bind + # The source should match the folder you made to store the Unchained index + source: /Users/user/Data/docker/unchained + target: /unchained + network_mode: "host" +``` + ## Other **Documentation** From 81955068fbfab208ff082bd7e09dc7fd4e0cf252 Mon Sep 17 00:00:00 2001 From: Thomas Jay Rush Date: Tue, 14 Mar 2023 11:22:42 -0400 Subject: [PATCH 2/6] Fixes issue #383 --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7cd67e2..24134e0 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This repo is pre-alpha and comes with no warranty implied or otherwise. Use at y ## Requirements -`docker` and `docker-compose-plugin` are required. +`docker` and `docker-compose-plugin` are required. Latest version is suggested. **Note:** this repo uses the Compose Plugin which uses the `docker compose` syntax NOT the Compose Standalone which uses `docker-compose`. @@ -169,13 +169,15 @@ docker compose -f docker-compose.yml -f docker-compose.volume-override.yml up ## Troubleshooting -If you are running your RPC directly on your host machine (and not within another docker container) you may get the message: +**Could not load RPC** + +If you are running your RPC directly on your host machine (not within a docker container) you may get the message: ``` Could not load RPC provider: Post "http://localhost:8545": dial tcp 127.0.0.1:8545: connect: connection refused ``` -Make docker use your host network by adding `network_mode: "host"` to your `docker-compose.yml`: +To fix this, tell docker to use your host network by adding `network_mode: "host"` to the `docker-compose.yml`: ```yml volumes: @@ -190,6 +192,10 @@ Make docker use your host network by adding `network_mode: "host"` to your `dock network_mode: "host" ``` +**additional property 'name' is not allowed** + +If you get this message, upgrade to the latest version of docker. + ## Other **Documentation** From 3b5ea391b9ca9bd94101fb69b5b29b14cbf886ef Mon Sep 17 00:00:00 2001 From: Thomas Jay Rush Date: Tue, 14 Mar 2023 11:24:48 -0400 Subject: [PATCH 3/6] Spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24134e0..f8d1c7e 100644 --- a/README.md +++ b/README.md @@ -192,7 +192,7 @@ To fix this, tell docker to use your host network by adding `network_mode: "host network_mode: "host" ``` -**additional property 'name' is not allowed** +**Additional property 'name' is not allowed** If you get this message, upgrade to the latest version of docker. From fc4b03f607d923e88da36ac4daa9a5fee97f223d Mon Sep 17 00:00:00 2001 From: Thomas Jay Rush Date: Tue, 14 Mar 2023 11:22:42 -0400 Subject: [PATCH 4/6] Fixes issue #383 --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7cd67e2..24134e0 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This repo is pre-alpha and comes with no warranty implied or otherwise. Use at y ## Requirements -`docker` and `docker-compose-plugin` are required. +`docker` and `docker-compose-plugin` are required. Latest version is suggested. **Note:** this repo uses the Compose Plugin which uses the `docker compose` syntax NOT the Compose Standalone which uses `docker-compose`. @@ -169,13 +169,15 @@ docker compose -f docker-compose.yml -f docker-compose.volume-override.yml up ## Troubleshooting -If you are running your RPC directly on your host machine (and not within another docker container) you may get the message: +**Could not load RPC** + +If you are running your RPC directly on your host machine (not within a docker container) you may get the message: ``` Could not load RPC provider: Post "http://localhost:8545": dial tcp 127.0.0.1:8545: connect: connection refused ``` -Make docker use your host network by adding `network_mode: "host"` to your `docker-compose.yml`: +To fix this, tell docker to use your host network by adding `network_mode: "host"` to the `docker-compose.yml`: ```yml volumes: @@ -190,6 +192,10 @@ Make docker use your host network by adding `network_mode: "host"` to your `dock network_mode: "host" ``` +**additional property 'name' is not allowed** + +If you get this message, upgrade to the latest version of docker. + ## Other **Documentation** From 264d96497586ea390d1fd328d37518955f4ea21c Mon Sep 17 00:00:00 2001 From: Thomas Jay Rush Date: Tue, 14 Mar 2023 11:24:48 -0400 Subject: [PATCH 5/6] Spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24134e0..f8d1c7e 100644 --- a/README.md +++ b/README.md @@ -192,7 +192,7 @@ To fix this, tell docker to use your host network by adding `network_mode: "host network_mode: "host" ``` -**additional property 'name' is not allowed** +**Additional property 'name' is not allowed** If you get this message, upgrade to the latest version of docker. From 899676dc9bbb392188d387a07090ec176c2570e1 Mon Sep 17 00:00:00 2001 From: Thomas Jay Rush Date: Tue, 14 Mar 2023 11:28:55 -0400 Subject: [PATCH 6/6] Fixes #375 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f8d1c7e..3dc7047 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,14 @@ This will produce the same results as the `curl` command. will show all available chifra tools. See the [full documentation](https://trueblocks.io/docs/) for detailed information. +**Pro user tip:** + +If you add this to your shell's init script, you will be able to run `chifra` from any command line: + +``` +alias chifra="cd //trueblocks-docker ; ./scripts/chifra.sh " +``` + ## The unchained index In the future, this docker will initialize and maintain [the Unchained Index](https://trueblocks.io/papers/2022/file-format-spec-v0.40.0-beta.pdf). Until then, you must initialize it and maintain it yourself.