Installation
Botmarley ships as a single server binary plus a PostgreSQL database. You need both running.
Requirements
- A Linux, macOS, or Windows machine you control (a small VPS is plenty).
- Docker, for the database. Or your own PostgreSQL if you prefer.
- About 200 MB of disk for the binary and growing space for market data.
1. Get the binary
Download the latest release from GitHub Releases and put it somewhere on your PATH, or just keep it in a working folder.
2. Start PostgreSQL
The quickest way is Docker:
docker compose up -d postgres
That starts a database with the default development credentials. For a real deployment, set your own connection string with the DATABASE_URL environment variable. See Production Deployment.
3. Run the server
./server
On first start it creates the tables it needs and writes its working files to ~/.botmarley.
4. Open the app
Go to http://localhost:3000. You should see the dashboard.
That's the whole install. Next, walk through the Quick Start to run your first backtest, or open the live demo to look around first.
Where Botmarley keeps its files
~/.botmarley/dataholds historical candle data in Apache Arrow format.~/.botmarley/.license_cacheholds your validated licence (signed, with a grace period).- Strategies live in
strats/next to the binary, split intobuiltin,example, anduser.
Environment variables
| Variable | What it does |
|---|---|
DATABASE_URL | PostgreSQL connection string. Overrides the default. |
KEYMARLEY_VALIDATE_URL | Licence server endpoint. Defaults to the hosted one. See Licensing. |
BACKTEST_SLIPPAGE_BPS | Optional slippage in basis points applied during backtests. Off by default. |
BOTMARLEY_DEMO_MODE | Set to 1 to run an open public demo with no licence gate. Leave unset for normal use. |