Skip to content

Commit d4eb498

Browse files
docs: update docs to mention the available docker-image
1 parent 561ff6f commit d4eb498

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,15 @@ SPEAKEASY_API_KEY='{API_KEY_HERE}' ./speakeasy-proxy
8787

8888
### Run Docker Image
8989

90-
If built locally:
90+
If using our pre-built image first pull the required image:
9191

9292
```bash
93-
docker run --network="host" -p 3333:3333 -v $(pwd)/config.yaml:/config.yaml -v $(pwd)/httpbin.yaml:/httpbin.yaml -e SPEAKEASY_API_KEY='{API_KEY_HERE}' speakeasy-proxy
93+
docker pull ghcr.io/speakeasy-api/speakeasy-proxy:latest
9494
```
9595

96-
If using our pre-built image:
96+
otherwise build the image yourself (see [Building](#building) for details).
97+
98+
Then run the image:
9799

98100
```bash
99-
```
101+
docker run --network="host" -p 3333:3333 -v $(pwd)/config.yaml:/config.yaml -v $(pwd)/httpbin.yaml:/httpbin.yaml -e SPEAKEASY_API_KEY='{API_KEY_HERE}' speakeasy-proxy

0 commit comments

Comments
 (0)