ScreenerBot
DocsGetting StartedInstallation Guide

Installation Guide

ScreenerBot is available as a bundled executable for macOS, Windows, and Linux. You can also run it on your own server for 24/7 operation. Follow this guide to get ScreenerBot installed on your system.

System Requirements

Minimum

  • CPU4 cores
  • RAM4 GB
  • Storage8 GB free space
  • NetworkStable broadband

Suitable for testing and light trading with limited positions.

Recommended

  • CPU8 cores
  • RAM8 GB
  • Storage15 GB free space
  • NetworkFast broadband

Best for active trading with multiple positions and strategies.

Best Performance

  • CPU8+ cores
  • RAM16 GB
  • Storage25 GB free space
  • NetworkPremium broadband

Ideal for heavy trading, extensive monitoring, and long-term data retention.

Storage Breakdown

Application

~250-350 MB installed (varies by platform: macOS ~280 MB, Linux ~310 MB, Windows ~350 MB)

Data Folder

~5 GB typical usage (tokens, pools, OHLCV, positions, transactions). Can reach 20 GB if events debugging is enabled (high-frequency logging).

Where the data folder lives

  • macOS: ~/Library/Application Support/ScreenerBot
  • Windows: %LOCALAPPDATA%\ScreenerBot
  • Linux: $XDG_DATA_HOME/ScreenerBot (fallback: ~/.local/share/ScreenerBot)

The app settings “About” tab shows the exact path and lets you open it in your file manager.

Prerequisites

Before You Install

  • Solana Wallet: Private key in base58 format for your trading wallet
  • RPC URLs: At least one Solana RPC endpoint (free or premium)
  • Fast Internet: Stable connection for real-time blockchain data
  • SOL for Trading: Funds in your wallet for trades and transaction fees

Download ScreenerBot

ScreenerBot is distributed as pre-built executables for all major platforms. Download the appropriate version for your operating system:

Recommended: Use Installer Packages

We recommend using installer packages (.dmg, .msi/.exe, .deb/.rpm) over ZIP archives for these benefits:

  • Easier updates: Installers integrate with system package managers and update mechanisms
  • Standard practices: Follows platform conventions for software installation
  • Better UX: Simple double-click installation vs manual extraction
  • System integration: Automatic menu entries, file associations, and uninstall support

ZIP archives are still available for advanced users who need portable installations or custom deployment scenarios.

Use the download page for the freshest links and SHA256 checksums.

macOS

  • macOS 11 (Big Sur) or later
  • Apple Silicon (M1/M2/M3/M4) or Intel
  • DMG installer (recommended)
Download for macOS

Windows

  • Windows 10 or later (64-bit)
  • MSI or EXE installer (recommended)
  • x64 or ARM64 architecture
Download for Windows

Linux

  • Ubuntu 20.04+ / Debian 11+ / Fedora 34+
  • Linux Mint 20+ / Pop!_OS 20.04+
  • DEB or RPM package (recommended)
  • x64 or ARM64 architecture
Download for Linux

Desktop Installation

macOS Installation

For macOS 11.0 (Big Sur) and later

  1. Download the .dmg file from the download page
  2. Open the downloaded DMG file
  3. Drag ScreenerBot to your Applications folder
  4. First Launch: Right-click ScreenerBot in Applications → "Open" (to bypass Gatekeeper)
  5. Click "Open" again in the security dialog
  6. ScreenerBot will create its data directory at ~/Library/Application Support/ScreenerBot

Important: If macOS blocks the app, go to System Preferences → Security & Privacy → General, and click "Open Anyway" next to the ScreenerBot message.

Windows Installation

For Windows 10 and Windows 11

  1. Download the .msi installer from the download page
  2. Run the MSI installer (double-click)
  3. Follow the installation wizard prompts
  4. Choose installation directory (default: C:\Program Files\ScreenerBot\)
  5. Complete the installation
  6. Launch ScreenerBot from the Start Menu or Desktop shortcut
  7. Data directory will be created at %LOCALAPPDATA%\ScreenerBot

Windows Defender: If SmartScreen blocks the installer, click "More info" → "Run anyway". ScreenerBot is safe but may trigger warnings as it's a new application.

Linux Installation

DEB (Ubuntu/Debian) or RPM (Fedora/RHEL) package

DEB Package (Ubuntu/Debian/Linux Mint/Pop!_OS)

  1. Download the .deb file for your architecture (x64 or ARM64)
  2. Install: sudo dpkg -i ScreenerBot*.deb
  3. If dependencies missing: sudo apt-get install -f
  4. Launch from menu or terminal: screenerbot

RPM Package (Fedora/RHEL/CentOS)

  1. Download the .rpm file for your architecture (x64 or ARM64)
  2. Install: sudo rpm -i ScreenerBot*.rpm
  3. Or with DNF: sudo dnf install ./ScreenerBot*.rpm
  4. Launch from menu or terminal: screenerbot

Portable ZIP (Advanced Users)

For custom deployments or when you need a portable installation without system integration.

  1. Download the .zip file for your architecture
  2. Extract: unzip ScreenerBot*.zip
  3. Run: ./ScreenerBot-linux-*/ScreenerBot
  4. Data directory: ~/.local/share/ScreenerBot

Supported Distributions: Ubuntu 20.04+, Debian 11+, Fedora 34+, Linux Mint 20+, Pop!_OS 20.04+, and any distribution with GLIBC 2.29 or newer.

Installation Paths: Executable at /usr/bin/screenerbot (runs as web server in headless mode), app files at /usr/lib/screenerbot/.

Post-Installation Checklist

Installation Complete

ScreenerBot is now installed on your system. Continue with the next steps:

Directory Structure

After first launch, ScreenerBot automatically creates the following directory structure in your OS data directory (see locations below).

Base Directory Location

macOS:~/Library/Application Support/ScreenerBot
Windows:%LOCALAPPDATA%\ScreenerBot
Linux:
$XDG_DATA_HOME/ScreenerBot(fallback: ~/.local/share/ScreenerBot)

Folder Structure

ScreenerBot (data directory)/   # Base directory
├── data/                      # All databases, configs, caches
│   ├── config.toml           # Main configuration file
│   ├── cache_pool/           # Pool cache files
│   ├── .screenerbot.lock     # Process lock file
│   │
│   ├── tokens.db             # Token discovery database
│   ├── positions.db          # Positions & trades database
│   ├── transactions.db       # Transaction history database
│   ├── wallet.db             # Wallet snapshots database
│   ├── events.db             # System events database
│   ├── pools.db              # Pool data database
│   ├── strategies.db         # Trading strategies database
│   ├── ohlcvs.db             # OHLCV price data database
│   ├── actions.db            # Action tracking database
│   │
│   ├── ata_failed_cache.json # Failed ATA cleanup cache
│   ├── token_blacklist.json  # Blacklisted tokens
│   ├── rpc_stats.json        # RPC usage statistics
│   └── entry_analysis.json   # Entry analysis cache
│
├── logs/                      # Daily log files (24h rotation)
│   └── screenerbot_YYYY-MM-DD_HH-MM-SS.log
│
└── analysis-exports/          # Exported CSV files
    └── *.csv

Automatic Creation: All directories and files are created automatically on first launch. You don't need to create anything manually.

Storage Growth: The data/ folder typically reaches ~5 GB with normal usage (tokens, pools, OHLCV, positions, transactions). Growth is proportional to the number of tracked tokens, OHLCV timeframes, and transaction history. If events debugging is enabled, storage can grow to 20 GB due to high-frequency event logging.

Backup Important Files: Keep backups of config.toml which contains your encrypted wallet data. Database files contain historical data but can be rebuilt if needed.

Verifying Installation

After installation, verify that ScreenerBot is working correctly:

  1. 1
    Launch ScreenerBot

    Open the application from your Applications folder, Start Menu, or terminal.

  2. 2
    Check Logs

    Look for startup messages in the terminal or log file. Should see "ScreenerBot starting up..."

  3. 3
    Access Dashboard

    Open your browser and navigate to http://localhost:8080. The dashboard should load.

  4. 4
    Complete Initial Setup

    If this is your first launch, you'll be guided through initial configuration. See the Setup Guide for details.

Installation Troubleshooting

App won't open (macOS)

Solution: Right-click → Open (not double-click) on first launch. Or go to System Preferences → Security & Privacy → General → click "Open Anyway".

Installer blocked (Windows)

Solution: Click "More info" in SmartScreen warning, then "Run anyway". The app is safe but unsigned.

Package installation fails (Linux)

Solution: For DEB packages, run sudo apt-get install -f to fix missing dependencies. For RPM packages, use sudo dnf install ./ScreenerBot*.rpm which auto-resolves dependencies. Ensure your system has GLIBC 2.29+.