From 33d37458e9cb62f8a61c385e10a17c89b2c835ae Mon Sep 17 00:00:00 2001 From: Robert Dyer Date: Fri, 13 Dec 2024 15:50:30 -0600 Subject: [PATCH] Update README.md to describe using Docker compose --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 29d2790..eb5a212 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,37 @@ BITCOIN_PAYEE_NAME="Bitcoin Price Change" Run `npm install` to install any required dependencies. -### Setup with Docker +### Using Docker Image + +The repository automatically builds and pushes a Docker image of itself every +time the repository is modified or Actual makes a new release. To use: + +```console +docker pull ghcr.io/psybers/actual-helpers +docker run -d --name actual-helpers ghcr.io/psybers/actual-helpers +``` + +Then you can run specific commands inside the container, e.g.: + +```console +docker exec actual-helpers node sync-banks.js +``` + +### Using Docker Compose + +An easier way to run is using Docker compose. Be sure to create your `.env` +file with all required settings in it. Then download the compose file +[docker-compose.yml](docker-compose.yml) and run: + +```console +docker compose up -d +docker exec -it actual-helpers node sync-banks.js +``` + +Note that most scripts do not need the `-it` flag, but some might prompt for +input (e.g. the track-investments.js script) and those will require this flag. + +### Building Docker Image This assumes you already have a working version of Docker installed and have cloned the repo to a location of your choice.