Skip to content

Commit 9bedf00

Browse files
committed
update readme to add dockerfile
taken from #148
1 parent a09c70f commit 9bedf00

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,19 @@ through the `RUST_LOG` environment variable using the standard
3737
Pyth agent will print logs in plaintext in terminal and JSON format in non-terminal environments (e.g. when writing to a file).
3838

3939
## Run
40-
`cargo run --release -- --config <your_config.toml>` will build and run the agent in a single step.
40+
### From Source
41+
The preferred way to run Pyth Agent is by compiling from source. You can run the below command to build and run the agent in a single step.
42+
43+
```bash
44+
cargo run --release -- --config <your_config.toml>
45+
```
46+
47+
### Container
48+
For convenience, a minimal container image is also published to [ECR Public](https://gallery.ecr.aws/pyth-network/agent). An example command for running this container can be found below. Make sure to update the image version to the latest release of Pyth Agent.
49+
50+
```bash
51+
docker run -v /path/to/configdir:/config:z,ro public.ecr.aws/pyth-network/agent:v2.12.0-minimal
52+
```
4153

4254
## Publishing API
4355
A running agent will expose a WebSocket serving the JRPC publishing API documented [here](https://docs.pyth.network/documentation/publish-data/pyth-client-websocket-api). See `config/config.toml` for related settings.

0 commit comments

Comments
 (0)