From 74732537b8df4433a24b4fa646e6af1d1d78002e Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 3 May 2024 06:42:37 +0200 Subject: [PATCH] Add explicit documentation page for freqUI --- docs/freq-ui.md | 12 ++++++++++++ docs/rest-api.md | 12 ++---------- 2 files changed, 14 insertions(+), 10 deletions(-) create mode 100644 docs/freq-ui.md diff --git a/docs/freq-ui.md b/docs/freq-ui.md new file mode 100644 index 000000000..eebd5e69c --- /dev/null +++ b/docs/freq-ui.md @@ -0,0 +1,12 @@ +# FreqUI + +Freqtrade provides a builtin webserver, which can serve [FreqUI](https://github.com/freqtrade/frequi), the freqtrade frontend. + +By default, the UI is automatically installed as part of the installation (script, docker). +freqUI can also be manually installed by using the `freqtrade install-ui` command. +This same command can also be used to update freqUI to new new releases. + +Once the bot is started in trade / dry-run mode (with `freqtrade trade`) - the UI will be available under the configured API port (by default `http://127.0.0.1:8080`). + +??? Note "Looking to contribute to freqUI?" + Developers should not use this method, but instead clone the corresponding use the method described in the [freqUI repository](https://github.com/freqtrade/frequi) to get the source-code of freqUI. A working installation of node will be required to build the frontend. diff --git a/docs/rest-api.md b/docs/rest-api.md index ab5e9db9f..6d2f26f19 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -1,16 +1,8 @@ -# REST API & FreqUI +# REST API ## FreqUI -Freqtrade provides a builtin webserver, which can serve [FreqUI](https://github.com/freqtrade/frequi), the freqtrade UI. - -By default, the UI is not included in the installation (except for docker images), and must be installed explicitly with `freqtrade install-ui`. -This same command can also be used to update freqUI, should there be a new release. - -Once the bot is started in trade / dry-run mode (with `freqtrade trade`) - the UI will be available under the configured port below (usually `http://127.0.0.1:8080`). - -!!! Note "developers" - Developers should not use this method, but instead use the method described in the [freqUI repository](https://github.com/freqtrade/frequi) to get the source-code of freqUI. +FreqUI now has it's own dedicated [documentation section](frequi.md) - please refer to that section for all information regarding the FreqUI. ## Configuration