From c72a4826f2e1f00f5eab98aa9d7c58de0f633858 Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Fri, 1 Nov 2024 08:40:59 +0100
Subject: [PATCH] docs: Update documentation for pre-built docker image

closes #2133
---
 README.md          | 16 +++++++++++++++-
 docker-compose.yml | 12 ++++++------
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 7ee856c7..c93dc61f 100644
--- a/README.md
+++ b/README.md
@@ -15,11 +15,25 @@ Using FreqUI, does require [freqtrade](https://github.com/freqtrade/freqtrade) t
 In newer versions (2021.2 and newer), freqUI is builtin to freqtrade, so manual setup of freqUI will no longer be necessary unless you want to modify freqUI.
 Instructions for this end-user setup can be found in the [freqtrade API documentation](https://www.freqtrade.io/en/stable/rest-api/).
 
+### Running a standalone version of FreqUI
+
+Using Docker, you can also run a pre-built docker image of FreqUI.
+
+```bash
+docker compose up -d
+```
+
+This will start a pre-built container with FreqUI running on port 3000 - which defaults to the latest version of freqUI.
+You can use `docker compose pull` to update to the latest version of the UI.
+
+Please note: This is a standalone version of FreqUI, and will still require a correctly configured freqtrade bot.
+You'll need to correctly configure [CORS](https://www.freqtrade.io/en/stable/rest-api/#cors) in freqtrade to allow FreqUI to connect to the API.
+
 ## Developer project setup
 
 It will require [freqtrade](https://github.com/freqtrade/freqtrade) to be running on the same host with the API enabled under (`localhost:8080`). You can either use the webpack proxy (port can be changed in `vue.config.js`) - or connect directly to the API (recommended).
 
-You will also have to have CORS for freqtrade configured correctly based on the [freqtrade documentation](https://www.freqtrade.io/en/latest/rest-api/#cors).
+You will also have to have CORS for freqtrade configured correctly based on the [freqtrade documentation](https://www.freqtrade.io/en/stable/rest-api/#cors).
 Most likely, the correct entry will be `http://localhost:3000` or `http://127.0.0.1:3000` - but the URL must match the URL you use to access FreqUI.
 Ports can vary, so check the URL you're using.
 
diff --git a/docker-compose.yml b/docker-compose.yml
index 60eb58d1..e22290a7 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,12 +1,12 @@
 ---
-version: '3.8'
 services:
   frequi:
-    build:
-      context: .
-      dockerfile: "./Dockerfile"
-    image: frequi
-    # image: freqtradeorg/frequi:main
+    # Uncomment the following lines to build the image locally
+    # build:
+    #   context: .
+    #   dockerfile: "./Dockerfile"
+    # image: frequi
+    image: freqtradeorg/frequi:latest
     restart: unless-stopped
     ports:
       - "3000:80"