DEV Community

Cover image for Chapter 7: How to Set Up the Freqtrade Web UI? Installation and Usage Guide
itrade icu
itrade icu

Posted on • Originally published at itrade.icu

Chapter 7: How to Set Up the Freqtrade Web UI? Installation and Usage Guide

#webdev #blockchain #python #web3

📘 Chapter 7: How to Set Up the Freqtrade Web UI? Installation and Usage Guide

When running Freqtrade for live trading or backtesting, you might want to monitor the strategy's performance, open positions, and profits in real-time. This is where the Web UI (FreqUI) comes in handy.

This article explains how to install and run the Web UI using both command-line and Docker methods, along with common use cases.

🚀 Want to Learn Quantitative Trading?

👉 Visit: https://www.itrade.icu
Find Freqtrade beginner tutorials, strategy guides, indicator analysis, and more to help you master quantitative trading with ease!

🧩 1. Install Web UI Dependencies

Before using the Web UI for the first time, you need to install the required dependencies with the following command:

freqtrade install-ui
Enter fullscreen mode Exit fullscreen mode

This command automatically installs the necessary modules for running the Web interface.

🚀 2. Start the Webserver Service

The webserver is the backend entry point for the UI, listening on a port (default: 8080).

freqtrade webserver \
  --config user_data/config.json
Enter fullscreen mode Exit fullscreen mode

By default, you can access the Web UI via a browser at:

http://localhost:8080
Enter fullscreen mode Exit fullscreen mode

⚙️ 3. Common Parameters Explained

Parameter Description
--config Specify the configuration file path
--port Specify the listening port (default: 8080)
--username / --password Set login username and password
--api-server Enable REST API service
--webserver Enable UI Web service (enabled by default)

🧱 Example: Start with a custom port and login credentials

freqtrade webserver \
  --config user_data/config.json \
  --port 8888 \
  --username admin \
  --password 123456
Enter fullscreen mode Exit fullscreen mode

🐳 4. Docker Setup for Web UI

If you're using Docker, you can configure it with the following docker-compose.yml file:

⚠️ Note: When using Docker, ensure the api_server.listen_port in config.json matches the ports setting in docker-compose.yml, otherwise, the UI won't be accessible.

    "api_server": {
        "enabled": true,
        "listen_ip_address": "127.0.0.1",
        "listen_port": 7777,
        "verbosity": "error",
        "enable_openapi": false,
        "jwt_secret_key": "",
        "ws_token": "",
        "CORS_origins": [],
        "username": "1",
        "password": "1"
    },
Enter fullscreen mode Exit fullscreen mode 
services:
  freqtrade:
    image: freqtradeorg/freqtrade:stable
    volumes:
      - ./user_data:/quants/freqtrade/user_data
    ports:
      - "8888:7777" # Access externally via http://localhost:8888
    command: >
      webserver
      --config /quants/freqtrade/user_data/config.json
      --username admin
      --password 123456
Enter fullscreen mode Exit fullscreen mode

Start the service:

docker compose up -d
Enter fullscreen mode Exit fullscreen mode

📊 6. Web UI Modules Explained

Freqtrade provides two Web UI interfaces for different scenarios:

✅ 1. Live Trading Web UI (enabled with freqtrade trade)

Used for real-time monitoring of trading bot performance:

  • View current strategy, open positions, and profit/loss
  • Manage open orders, close positions, or create manual trades (requires API enabled)
  • Browse historical trade records and profit/loss charts

Start command:

freqtrade trade --config user_data/config.json
Enter fullscreen mode Exit fullscreen mode

🧪 2. Backtesting Web UI

Used for visualizing backtesting results:

  • Graphical display of profit/loss curves, indicator lines, and buy/sell points
  • Overview of strategy performance and trade statistics
  • Requires running freqtrade backtesting to generate results first

Start command:

freqtrade webserver --config user_data/config.json
Enter fullscreen mode Exit fullscreen mode

🔧 7. Notes and Common Issues

Issue Solution
Unable to access UI Ensure the correct webserver mode is running and the port is open
Blank page / style issues Run freqtrade install-ui to install frontend dependencies
Docker UI inaccessible Check docker-compose.yml for ports: 8888:8080 mapping
UI doesn't recognize strategy Ensure the strategy file name is correct and matches the "strategy" field in config.json
Backtesting UI shows no data Ensure freqtrade backtesting has been run to generate results before starting webserver

📌 Summary

The Freqtrade Web UI is a lightweight and practical visualization tool that can be used to:

  • Monitor trading status in real-time
  • View backtesting or live trading performance
  • Manually intervene in trading actions

If you're familiar with the CLI but want a more intuitive way to manage strategies and assets, the Web UI is highly recommended!

Top comments (0)