freqtrade_origin/docs/freq-ui.md

1.4 KiB

FreqUI

Freqtrade provides a builtin webserver, which can serve 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 to get the source-code of freqUI. A working installation of node will be required to build the frontend.

!!! tip "freqUI is not required to run freqtrade" freqUI is an optional component of freqtrade, and is not required to run the bot. It is a frontend that can be used to monitor the bot and to interact with it - but freqtrade itself will work perfectly fine without it.

Configuration

FreqUI does not have it's own configuration file - but assumes a working setup for the rest-api is available. Please refer to the corresponding documentation page to get setup with freqUI

--8<-- "includes/cors.md"