From 9114ee17d4b14e67faeadebf83cd0b1668775045 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sun, 16 Nov 2025 22:56:39 +0100 Subject: [PATCH] docs: document docker image update script usage MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- README.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1512060..77db1ff 100644 --- a/README.md +++ b/README.md @@ -128,20 +128,20 @@ The rewarding logic and tunables are documented in the [reward space analysis](. ## Common workflows -List running compose services and the containers they created: +**List running compose services and the containers they created:** ```shell docker compose ps ``` -Enter a running service: +**Enter a running service:** ```shell # use the compose service name (e.g. "freqtrade") docker compose exec freqtrade /bin/sh ``` -View logs: +**View logs:** ```shell # service logs (compose maps service -> container(s)) @@ -151,12 +151,36 @@ docker compose logs -f freqtrade docker logs -f freqtrade-quickadapter ``` -Stop and remove the compose stack: +**Stop and remove the compose stack:** ```shell docker compose down ``` +**Automatically update Freqtrade Docker images:** + +```shell +cd ReforceXY # or quickadapter +cp ../scripts/docker-upgrade.sh . +./docker-upgrade.sh +``` + +The script checks for new Freqtrade image versions on Docker Hub, rebuilds and restarts containers if updates are found, sends Telegram notifications (if configured), and cleans up unused images. + +_Configuration and environment variables:_ + +| Variable | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------ | +| FREQTRADE_CONFIG | `./user_data/config.json` | Freqtrade configuration file path | +| LOCAL_DOCKER_IMAGE | `reforcexy-freqtrade` | Local image name | +| REMOTE_DOCKER_IMAGE | `freqtradeorg/freqtrade:stable_freqairl` | Freqtrade image to track for updates | + +_Cronjob setup (daily check at 3:00 AM):_ + +```cron +0 3 * * * cd /path/to/freqai-strategies/ReforceXY && ./docker-upgrade.sh >> user_data/logs/docker-upgrade.log 2>&1 +``` + --- ## Note -- 2.43.0