From 399c7ea8edc6d950e3aeb2b006e73552e4427134 Mon Sep 17 00:00:00 2001 From: Anton Kaliaev Date: Wed, 16 May 2018 16:34:48 +0400 Subject: [PATCH] [tm-monitor] update readme Refs #92 --- tm-monitor/README.rst | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/tm-monitor/README.rst b/tm-monitor/README.rst index 1a8bc63f3..9750fe79a 100644 --- a/tm-monitor/README.rst +++ b/tm-monitor/README.rst @@ -12,22 +12,40 @@ Quick Start Docker ~~~~~~ +Assuming your application is running in another container with the name ``app``: + :: docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init - docker run -it --rm -v "/tmp:/tendermint" -p "46657:46657" --name=tm tendermint/tendermint + docker run -it --rm -v "/tmp:/tendermint" -p "46657:46657" --name=tm --link=app tendermint/tendermint node --proxy_app=tcp://app:46658 - docker run -it --rm --link=tm tendermint/monitor tm:46657 + docker run -it --rm -p "46670:46670" --link=tm tendermint/monitor tm:46657 + +If you don't have an application yet, but still want to try monitor out, use ``kvstore``: + +:: + + docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init + docker run -it --rm -v "/tmp:/tendermint" -p "46657:46657" --name=tm tendermint/tendermint node --proxy_app=kvstore + + docker run -it --rm -p "46670:46670" --link=tm tendermint/monitor tm:46657 Binaries ~~~~~~~~ -This will be the same as you did for ``tm-bench`` above, except for the last line which should be: - :: tm-monitor localhost:46657 +Build from source +~~~~~~~~~~~~~~~~~ + +:: + + make get_tools + make get_vendor_deps + make install + Usage ^^^^^ @@ -70,5 +88,6 @@ Development :: + make get_tools make get_vendor_deps make test