Config File Reference

Manual editing reference for config.toml - For advanced users only. Always prefer using the Dashboard Configuration interface.

Use Dashboard Configuration Instead

Strongly Recommended: Always use the Dashboard Configuration interface to modify settings. Manual config file editing is only for advanced users in specific situations.

Why Use Dashboard?

• Instant validation of values
• Prevents syntax errors
• Auto-completes valid options
• Built-in documentation
• Safe hot-reload without restart

Risks of Manual Editing

• Syntax errors break bot startup
• Invalid values cause failures
• No validation until restart
• Easy to corrupt configuration
• Structure changes in updates

Configuration Structure

Config Structure Changes in Updates

Important: The config.toml file structure may change between updates. New fields can be added, old fields renamed or removed, and default values adjusted.

What This Means:

Manual edits may be overwritten during updates
Old field names may become invalid
You'll need to re-apply custom changes after updates
Dashboard config always stays current with latest structure

Best Practice: After any bot update, review your configuration in the Dashboard to ensure all settings are still valid and properly migrated.

File Location

config.toml Location

Default Locations by Platform:

macOS:

~/Library/Application Support/ScreenerBot/data/config.toml

Windows:

%LOCALAPPDATA%\ScreenerBot\data\config.toml

Linux:

$XDG_DATA_HOME/ScreenerBot/data/config.toml (fallback: ~/.local/share/ScreenerBot/data/config.toml)

You can view the exact file path in the Dashboard Configuration page.

File Format

TOML Format Basics

config.toml uses the TOML (Tom's Obvious, Minimal Language) format. It's human-readable but strict about syntax.

Section Headers:

[trader]
[positions]
[filtering]
[swaps]

Common Value Types:

# String values (encrypted wallet data)
wallet_encrypted = "base64_encrypted_ciphertext..."
wallet_nonce = "base64_encoded_nonce..."

# Number values
max_positions = 5
buy_amount_sol = 0.5

# Boolean values
auto_trading_enabled = true
use_trailing_stop = false

# Array values
rpc_urls = ["https://rpc1.com", "https://rpc2.com"]

Critical Fields

Never Manually Edit These Fields

Sensitive Data (Auto-managed):

wallet_encrypted / wallet_nonce - Encrypted wallet data, never manually edit
rpc.urls - May contain API keys in URLs

Complex Structures:

Filtering criteria (complex nested objects)
Strategy definitions (requires specific format)
Service priorities (affects startup order)

Webserver Configuration (VPS/Server)

Configure Dashboard Access for Headless Mode

The [webserver] section controls how the dashboard is served in headless mode. In headless mode, ScreenerBot runs as a web server that serves the dashboard on port 8080, accessible via any browser. These settings are only used in headless/server deployments — the GUI application manages its own webserver automatically.

[webserver]
# Port number for the dashboard (default: 8080)
port = 8080

# Bind address:
# - "127.0.0.1" = localhost only (secure, default)
# - "0.0.0.0" = all network interfaces (for remote access)
host = "127.0.0.1"

Local Development

host = "127.0.0.1"
port = 8080

Access at http://localhost:8080

VPS Remote Access

host = "0.0.0.0"
port = 8080

Access at http://server-ip:8080 (use firewall!)

Security Warning: When using host = "0.0.0.0", configure your firewall to restrict access. Better option: use SSH tunneling with localhost binding for secure remote access.

Safe Manual Editing (If Needed)

When Manual Editing May Be Acceptable

Safe to Edit:

Simple numeric values (amounts, limits)
Boolean toggles (true/false)
Timeout values
Display preferences

Edit with Caution:

URLs and endpoints
Array values
Percentage values
Service configurations

Best Practices

Do This

•Always backup config.toml before editing
•Use Dashboard configuration whenever possible
•Stop the bot before manual editing (see Running the Bot)
•Test changes by restarting bot
•Keep backup of working configuration
•Review config after updates

Don't Do This

•Edit while bot is running
•Modify without backing up first
•Change private key manually
•Add custom fields (they'll be ignored)
•Use text editors with auto-formatting
•Assume structure stays same after updates

Recovery from Errors

If Config File Becomes Corrupted

Stop the bot immediately
Restore from backup (if you have one)
Copy your backup to data/config.toml
Or use Dashboard to reset
Dashboard can export/import configuration or reset to defaults
Re-enter critical values
Wallet private key, RPC URLs (via Dashboard)
Restart and verify
Check logs for any configuration errors

Getting Started

Dashboard Guides

Trading Guides

Reference

Trading Tools

Need Help?