跳到主要内容

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 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).

FreqUI is Optional

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.

Contributing 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.

Installation and Setup​

Automatic Installation​

FreqUI is installed automatically with most Freqtrade installations:

# Docker installations include FreqUI
docker compose up -d

# Setup script installations include FreqUI
./setup.sh

Manual Installation​

# Install FreqUI
freqtrade install-ui

# Update FreqUI to latest version
freqtrade install-ui --ui-version latest

Configuration​

FreqUI does not have its own configuration file - but assumes a working setup for the REST API is available.

Basic API Configuration:

{
    "api_server": {
        "enabled": true,
        "listen_ip_address": "127.0.0.1",
        "listen_port": 8080,
        "verbosity": "error",
        "enable_openapi": false,
        "jwt_secret_key": "somethingrandom",
        "username": "freqtrader",
        "password": "SuperSecret1!",
        "ws_token": "secret_ws_token"
    }
}

Docker Configuration:

{
    "api_server": {
        "enabled": true,
        "listen_ip_address": "0.0.0.0",
        "listen_port": 8080,
        "username": "freqtrader",
        "password": "SuperSecret1!"
    }
}

Accessing FreqUI​

Local Access​

After starting Freqtrade with API enabled:

# Start bot with API
freqtrade trade --config config.json

# Access FreqUI in browser
http://127.0.0.1:8080

Remote Access​

For remote access, consider security implications:

Option 1: SSH Tunnel (Recommended)

# Create SSH tunnel
ssh -L 8080:localhost:8080 user@your-server

# Access via local browser
http://127.0.0.1:8080

Option 2: VPN Access

  • Set up VPN (OpenVPN, WireGuard)
  • Access FreqUI through VPN connection

Option 3: Direct Access (Not Recommended)

{
    "api_server": {
        "listen_ip_address": "0.0.0.0",
        "CORS_origins": ["https://yourdomain.com"]
    }
}
Security Warning

Direct internet exposure of FreqUI is not recommended. Always use strong passwords and consider additional security measures.

User Interface Overview​

Login Screen​

FreqUI requires authentication using the configured username and password.

FreqUI Login

Login Process:

  1. Enter configured username and password
  2. Click "Login" to authenticate
  3. Session will be maintained until logout or expiry

Dashboard​

The main dashboard provides an overview of bot performance:

  • Current Status - Bot state (running, stopped, paused)
  • Open Trades - Active positions
  • Performance Metrics - Profit/loss statistics
  • Recent Activity - Latest trades and actions

Trade View​

The trade view is the main interface for monitoring and controlling trades:

Features:

  • Trade List - View all open and closed trades
  • Trade Details - Detailed information for each trade
  • Manual Controls - Force entry/exit trades (if enabled)
  • Real-time Updates - Live trade status updates

FreqUI Trade View

Trade Information Displayed:

  • Pair and direction (long/short)
  • Entry price and current price
  • Profit/loss (absolute and percentage)
  • Trade duration
  • Stop loss and take profit levels

Chart View​

Interactive charts for technical analysis:

Chart Features:

  • Candlestick Charts - OHLCV data visualization
  • Technical Indicators - Overlay indicators from strategy
  • Trade Markers - Entry and exit points
  • Zoom and Pan - Interactive chart navigation
  • Multiple Timeframes - Switch between different timeframes

Customization Options:

  • Add/remove indicators
  • Change chart colors and themes
  • Configure plot layouts
  • Save chart configurations

Plot Configurator​

Configure chart displays and indicators:

FreqUI Plot Configurator

Configuration Options:

  • Main Plot - Price data and overlays
  • Subplots - Additional indicator panels
  • Colors - Customize chart appearance
  • Strategy Plots - Load from strategy configuration

Performance View​

Analyze bot performance with detailed metrics:

Performance Metrics:

  • Total Return - Overall profit/loss
  • Win Rate - Percentage of profitable trades
  • Average Trade Duration - Time per trade
  • Maximum Drawdown - Largest loss period
  • Sharpe Ratio - Risk-adjusted returns

Visualization:

  • Profit/loss charts over time
  • Trade distribution analysis
  • Performance by pair
  • Monthly/daily breakdowns

Settings​

Customize FreqUI behavior and appearance:

FreqUI Settings

Available Settings:

  • Timezone - Display timezone for dates/times
  • Theme - Light or dark theme
  • Notifications - Enable/disable various alerts
  • Chart Settings - Default chart configurations
  • Auto-refresh - Update intervals for data

Backtesting Interface​

When Freqtrade is started in webserver mode (freqtrade webserver), the backtesting interface becomes available.

Backtesting Features​

Strategy Testing:

  • Select strategies from dropdown
  • Configure backtesting parameters
  • Set timerange and pairs
  • Run backtests directly from UI

Results Analysis:

  • View backtesting results in tables
  • Interactive performance charts
  • Compare multiple backtest runs
  • Export results for further analysis

FreqUI Backtesting

Backtesting Configuration:

  • Strategy selection
  • Timerange specification
  • Pair selection
  • Stake amount and max trades
  • Fee configuration

Advanced Features​

WebSocket Integration​

FreqUI uses WebSockets for real-time updates:

  • Live Trade Updates - Real-time trade status
  • Price Updates - Current market prices
  • Bot Status - Connection and operational status
  • Notifications - Instant alerts and messages

Multi-Bot Support​

FreqUI can connect to multiple Freqtrade instances:

{
    "api_server": {
        "enabled": true,
        "listen_port": 8080
    }
}

Configuration for Multiple Bots:

  • Use different ports for each bot
  • Configure separate API credentials
  • Access each bot via different URLs

Custom Themes​

FreqUI supports light and dark themes:

  • Automatic Theme - Follow system preference
  • Light Theme - Bright, clean interface
  • Dark Theme - Dark background, easier on eyes
  • Custom Colors - Configurable chart colors

Troubleshooting​

Common Issues​

Cannot Access FreqUI:

  • Check if API server is enabled in configuration
  • Verify correct IP address and port
  • Check firewall settings
  • Ensure bot is running

Login Failures:

  • Verify username and password in configuration
  • Check for typos in credentials
  • Ensure JWT secret is configured
  • Try clearing browser cache

Charts Not Loading:

  • Check WebSocket connection
  • Verify data availability
  • Check browser console for errors
  • Try refreshing the page

CORS Errors:

{
    "api_server": {
        "CORS_origins": ["http://localhost:3000", "https://yourdomain.com"]
    }
}

Performance Optimization​

Improve Loading Speed:

  • Reduce number of displayed trades
  • Limit chart data range
  • Disable unnecessary real-time updates
  • Use appropriate refresh intervals

Memory Usage:

  • Clear browser cache regularly
  • Close unused browser tabs
  • Limit historical data display
  • Use efficient chart configurations

Security Considerations​

Authentication​

  • Strong Passwords - Use complex, unique passwords
  • JWT Secrets - Generate secure JWT secret keys
  • Session Management - Configure appropriate session timeouts

Network Security​

  • Local Access Only - Bind to localhost when possible
  • VPN/SSH Tunnels - Use secure connections for remote access
  • HTTPS - Consider reverse proxy with SSL/TLS
  • Firewall Rules - Restrict access to necessary IPs only

API Security​

  • Limited Permissions - Use minimal required API permissions
  • Regular Updates - Keep FreqUI updated to latest version
  • Monitor Access - Review access logs regularly
  • Backup Configurations - Secure backup of configurations

Best Practices​

Usage Recommendations​

  1. Start with Dry Run - Test FreqUI with paper trading first
  2. Monitor Regularly - Check bot status and performance frequently
  3. Use Alerts - Configure notifications for important events
  4. Backup Settings - Save chart configurations and settings
  5. Security First - Always prioritize security over convenience

Performance Tips​

  1. Optimize Charts - Use appropriate timeframes and indicators
  2. Limit Data - Don't load excessive historical data
  3. Regular Maintenance - Clear cache and update regularly
  4. Monitor Resources - Watch server resource usage
  5. Network Stability - Ensure stable internet connection

Next Steps​

After setting up FreqUI:

  1. Bot Usage - Learn to operate the bot effectively
  2. Strategy Development - Create and test strategies
  3. Backtesting - Use backtesting interface
  4. REST API - Understand underlying API

Resources​

最后由 huojiabin 于 更新