Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zengzengzenghuy committed Sep 23, 2024
1 parent 93f96f5 commit 3c0f4f3
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 12 deletions.
9 changes: 9 additions & 0 deletions docker-compose-reporter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: "3.8"

services:

hashi_reporter:
build:
context: .
dockerfile: packages/reporter/Dockerfile
container_name: hashi_reporter
33 changes: 32 additions & 1 deletion packages/executor/README.md
Original file line number Diff line number Diff line change
@@ -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.

 

Expand All @@ -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
Expand Down Expand Up @@ -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]
```
30 changes: 30 additions & 0 deletions packages/relayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
```
14 changes: 3 additions & 11 deletions packages/reporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3c0f4f3

Please sign in to comment.