diff --git a/README.md b/README.md index e73b02c..9bf5c49 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Easily check the system status, perform various actions and manage your configur - [Via config file / command line arguments](#via-config-file--command-line-arguments) - [Installation](#installation) - [Building from source](#building-from-source) + - [Running with docker-compose](#running-with-docker-compose) - [Running with Docker](#running-with-docker) - [Example output](#example-output) - [Result](#result) @@ -141,7 +142,7 @@ cp config-sample.yml config.yml http://localhost:3000 ``` -#### Running with Docker +#### Running with docker-compose The simplest way to run the whole setup is by using the included docker compose Copy the config and edit it as needed. By default, the values for postgres and redis are correct for using with docker compose. @@ -156,11 +157,31 @@ Start everything docker-compose up -d ``` +Open the dashboard to check progress +``` +http://localhost:3000 +``` + +#### Running with Docker If you already have a postgres instance & a redis instance set up and still want the simplest way, you can use the docker image from Dockerhub. + +Copy the config and edit it as needed, making sure Memento is able to connect to postgres, redis and the Ethereum client of choice. ```shell script -docker run --name memento -d -v /path/to/config/folder:/config/ alethio/memento:latest +mkdir -p .volumes/memento + +cp config-sample.yml .volumes/memento/config.yml ``` +Start memento in Docker +```shell script +docker run --name memento -d -v /path/to/config/folder:/config/ -p 3000:3000 -p 3001:3001 alethio/memento:latest +``` + +Open the dashboard to check progress +``` +http://localhost:3000 +``` + #### Example output ![image](https://user-images.githubusercontent.com/8313779/68114387-9109d600-fefe-11e9-8fd0-9666968654a7.png)