From c298ff52f39eceff715836f5a9b1954a3c8150aa Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Tue, 7 Jan 2025 21:16:21 -0500 Subject: [PATCH] Update readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 3dc6f7e..1bfc666 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,22 @@ Example: --endpoint https://example.com ``` +You can also run it with Docker compose. For example, a service in your `docker-compose.yml` might look like this using environment vars (recommended): + +```yaml +services: + newt: + image: fosrl/newt + container_name: newt + restart: unless-stopped + environment: + - PANGOLIN_ENDPOINT=https://example.com + - NEWT_ID=2ix2t8xk22ubpfy + - NEWT_SECRET=nnisrfsdfc7prqsp9ewo1dvtvci50j5uiqotez00dgap0ii2 +``` + +You can also pass the CLI args to the container: + ```yaml services: newt: