diff --git a/docker-compose-reporter.yml b/docker-compose-reporter.yml new file mode 100644 index 00000000..629edff2 --- /dev/null +++ b/docker-compose-reporter.yml @@ -0,0 +1,9 @@ +version: "3.8" + +services: + + hashi_reporter: + build: + context: . + dockerfile: packages/reporter/Dockerfile + container_name: hashi_reporter \ No newline at end of file diff --git a/packages/executor/README.md b/packages/executor/README.md index c9829440..8563752f 100644 --- a/packages/executor/README.md +++ b/packages/executor/README.md @@ -1,6 +1,7 @@ # executor -The Executor is a service utilized to execute messages once they have achieved consensus, meaning when adapters have reached consensus on the message. +The Executor is a service utilized to execute messages once they have achieved consensus, meaning when adapters have +reached consensus on the message.   @@ -9,6 +10,7 @@ The Executor is a service utilized to execute messages once they have achieved c   ## Installation + To install the Executor, follow these steps: ```bash @@ -46,3 +48,32 @@ cd packages/executor yarn start dotenv_config_path="your env file" ``` +### Building and Running the Docker Image + +Executor is usually run with Relayer and MongoDB, the `docker-compose.yml` demonstrates how to run these three images +together. + +Run the following command: + +```sh +cd ../.. # To the root level +docker compose -f docker-compose.yml up -d --build +``` + +### Viewing Logs + +To view the logs from the running container, use: + +```sh +docker logs -f [CONTAINER_ID or CONTAINER_NAME] +``` + +You can find the `CONTAINER_ID` or `CONTAINER_NAME` using `docker ps`. + +### Stopping the relayer + +To stop the running container: + +```sh +docker stop [CONTAINER_ID or CONTAINER_NAME] +``` diff --git a/packages/relayer/README.md b/packages/relayer/README.md index da4019d1..4bdd1fbc 100644 --- a/packages/relayer/README.md +++ b/packages/relayer/README.md @@ -46,3 +46,33 @@ cd packages/relayer ```bash yarn start dotenv_config_path="your env file" ``` + +### Building and Running the Docker Image + +Relayer is usually run with Executor and MongoDB, the `docker-compose.yml` demonstrates how to run these three images +together. + +Run the following command: + +```sh +cd ../.. # To the root level +docker compose -f docker-compose.yml up -d --build +``` + +### Viewing Logs + +To view the logs from the running container, use: + +```sh +docker logs -f [CONTAINER_ID or CONTAINER_NAME] +``` + +You can find the `CONTAINER_ID` or `CONTAINER_NAME` using `docker ps`. + +### Stopping the relayer + +To stop the running container: + +```sh +docker stop [CONTAINER_ID or CONTAINER_NAME] +``` diff --git a/packages/reporter/README.md b/packages/reporter/README.md index 9cb4ab9a..da4b9a2c 100644 --- a/packages/reporter/README.md +++ b/packages/reporter/README.md @@ -16,20 +16,12 @@ These instructions will cover the usage information and how to run the code usin Configure the mode you want to run by editing the variable in `.env` by checking `.env.example` -### Building the Docker Image +### Building and Running the Docker Image -To build the Docker image, run the following command from the root of the project: +On the root, run the following command: ```sh -docker build -t reporter . -``` - -### Running the reporter - -After building the image, you can run it using the following command: - -```sh -docker run -d -p reporter +docker compose -f docker-compose-reporter.yml up -d --build ``` ### Viewing Logs