Skip to content
This repository has been archived by the owner on Aug 26, 2022. It is now read-only.

Commit

Permalink
Updated README with docker image location
Browse files Browse the repository at this point in the history
  • Loading branch information
manicprone committed Dec 6, 2021
1 parent 36597e1 commit e2f2db5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@

The Atomic Agent service contains three utilities: `migrate`, `api`, `worker`. The API and worker utilities work together to provide the running service, while the migrate utility is utilized to initialize the database with market data.

The API and worker utilities are also distributed as Docker images:
* `atomicagent-api`
* `atomicagent-worker`

> Found here: https://github.com/orgs/liquality/packages?repo_name=atomicagent

## Prerequisites

Expand Down Expand Up @@ -120,6 +126,15 @@ To run the utilities locally as Docker containers, make a copy of the `sample.co
> **TIP:** You can use the `config/local/run-mongodb.yml` config to run a simple MongoDB locally.
Ensure you have configured your desired markets and assets to run. The migrate utility will run automatically when the container starts, if the database is empty.

You can configure the markets and assets in the following files:

```
src/migrate/data/markets.json
src/migrate/data/assets.json
```

To run the API as a container locally:

| Command | Description |
Expand All @@ -139,6 +154,10 @@ To run the worker as a container locally:
| `docker:stop-worker-local` | Stops the running "atomicagent-worker-local" container. |


### Docker Image Settings

[TBC]

### Run the Full Swap System

The atomicagent service operates on multiple dependencies (for various chains/networks), as well as requiring a MongoDB to read/write data.
Expand Down

0 comments on commit e2f2db5

Please sign in to comment.