Skip to content

Commit

Permalink
Better example in README
Browse files Browse the repository at this point in the history
  • Loading branch information
zbuc committed Jun 16, 2024
1 parent ee919cf commit 491d137
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ See [GH29](https://github.com/penumbra-zone/galileo/issues/29) for details.
## Running it

```bash
RUST_LOG=osiris=debug cargo run --release serve BTC USD ATOM
RUST_LOG=osiris=debug cargo run --release serve USDT ETH OSMO BTC
```

This will monitor the [Binance websockets API](https://developers.binance.com/docs/binance-trading-api/websocket_api) for
Expand All @@ -40,6 +40,7 @@ A variety of options are available, including adjusting replication timing, and
connect to (the default is the hosted Penumbra default testnet). Use the `--help` option for more details.

## Re-deploying after a testnet release

During deploy of a new testnet, Osiris will automatically be restarted, but
it won't be using a new image built from the latest code. Sometimes that's OK,
but we aim to keep the deployments in sync, so the dependencies match.
Expand All @@ -54,6 +55,7 @@ Perform these steps manually after deploying a new testnet:
Eventually we should automate these steps so they're performed automatically as part of a release.

# Bouncing deployments

Restarting the Osiris service will cause the deployment to pull for a new container image.
If a newer container image exists in the remote repository (`ghcr.io/penumbra-zone/osiris`),
that image will be used. You must manually build a new image via the [GHA setup](https://github.com/penumbra-zone/osiris/actions).
Expand Down

0 comments on commit 491d137

Please sign in to comment.