9.0 KiB

Raw Blame History

Installation

This page explains how to prepare your environment for running the bot.

To understand how to set up the bot please read the Bot Configuration page.

Table of Contents
Easy Installation - Linux Script
Automatic Installation - Docker
Custom Linux MacOS Installation
Windows

Easy Installation - Linux Script

If you are on Debian, Ubuntu or MacOS a freqtrade provides a script to Install, Update, Configure, and Reset your bot.

$ ./setup.sh
usage:
	-i,--install    Install freqtrade from scratch
	-u,--update     Command git pull to update.
	-r,--reset      Hard reset your develop/master branch.
	-c,--config     Easy config generator (Will override your existing file).

--install

This script will install everything you need to run the bot:

Mandatory software as: Python3, ta-lib, wget
Setup your virtualenv
Configure your config.json file

This script is a combination of install script --reset, --config

--update

Update parameter will pull the last version of your current branch and update your virtualenv.

--reset

Reset parameter will hard reset your branch (only if you are on master or develop) and recreate your virtualenv.

--config

Config parameter is a config.json configurator. This script will ask you questions to setup your bot and create your config.json.

Automatic Installation - Docker

Start by downloading Docker for your platform:

Once you have Docker installed, simply create the config file (e.g. config.json) and then create a Docker image for freqtrade using the Dockerfile in this repo.

1. Prepare the Bot

1.1. Clone the git repository

git clone https://github.com/gcarq/freqtrade.git

1.2. (Optional) Checkout the develop branch

git checkout develop

1.3. Go into the new directory

cd freqtrade

1.4. Copy `config.json.example` to `config.json`

cp -n config.json.example config.json

To edit the config please refer to the Bot Configuration page.

1.5. Create your database file (optional - the bot will create it if it is missing)

Production

touch tradesv3.sqlite

Dry-Run

touch tradesv3.dryrun.sqlite

2. Build the Docker image

cd freqtrade
docker build -t freqtrade .

For security reasons, your configuration file will not be included in the image, you will need to bind mount it. It is also advised to bind mount an SQLite database file (see the "5. Run a restartable docker image" section) to keep it between updates.

3. Verify the Docker image

After the build process you can verify that the image was created with:

docker images

4. Run the Docker image

You can run a one-off container that is immediately deleted upon exiting with the following command (config.json must be in the current working directory):

docker run --rm -v /etc/localtime:/etc/localtime:ro -v `pwd`/config.json:/freqtrade/config.json -it freqtrade

In this example, the database will be created inside the docker instance and will be lost when you will refresh your image.

5. Run a restartable docker image

To run a restartable instance in the background (feel free to place your configuration and database files wherever it feels comfortable on your filesystem).

5.1. Move your config file and database

mkdir ~/.freqtrade
mv config.json ~/.freqtrade
mv tradesv3.sqlite ~/.freqtrade

5.2. Run the docker image

docker run -d \
  --name freqtrade \
  -v /etc/localtime:/etc/localtime:ro \
  -v ~/.freqtrade/config.json:/freqtrade/config.json \
  -v ~/.freqtrade/tradesv3.sqlite:/freqtrade/tradesv3.sqlite \
  freqtrade

If you are using dry_run=True it's not necessary to mount tradesv3.sqlite, but you can mount tradesv3.dryrun.sqlite if you plan to use the dry run mode with the param --dry-run-db.

6. Monitor your Docker instance

You can then use the following commands to monitor and manage your container:

docker logs freqtrade
docker logs -f freqtrade
docker restart freqtrade
docker stop freqtrade
docker start freqtrade

You do not need to rebuild the image for configuration changes, it will suffice to edit config.json and restart the container.

Custom Installation

We've included/collected install instructions for Ubuntu 16.04, MacOS, and Windows. These are guidelines and your success may vary with other distros.

Requirements

Click each one for install guide:

Python 3.6.x, note the bot was not tested on Python >= 3.7.x
pip
git
virtualenv (Recommended)
TA-Lib

Linux - Ubuntu 16.04

1. Install Python 3.6, Git, and wget

sudo add-apt-repository ppa:jonathonf/python-3.6
sudo apt-get update
sudo apt-get install python3.6 python3.6-venv python3.6-dev build-essential autoconf libtool pkg-config make wget git

2. Install TA-Lib

Official webpage: https://mrjbq7.github.io/ta-lib/install.html

wget http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
tar xvzf ta-lib-0.4.0-src.tar.gz
cd ta-lib
./configure --prefix=/usr
make
make install
cd ..
rm -rf ./ta-lib*

3. [Optional] Install MongoDB

Install MongoDB if you plan to optimize your strategy with Hyperopt.

sudo apt-get install mongodb-org

Complete tutorial from Digital Ocean: How to Install MongoDB on Ubuntu 16.04.

4. Install FreqTrade

Clone the git repository:

git clone https://github.com/gcarq/freqtrade.git

Optionally checkout the develop branch:

git checkout develop

5. Configure `freqtrade` as a `systemd` service

From the freqtrade repo... copy freqtrade.service to your systemd user directory (usually ~/.config/systemd/user) and update WorkingDirectory and ExecStart to match your setup.

After that you can start the daemon with:

systemctl --user start freqtrade

For this to be persistent (run when user is logged out) you'll need to enable linger for your freqtrade user.

sudo loginctl enable-linger "$USER"

MacOS

1. Install Python 3.6, git, wget and ta-lib

brew install python3 git wget ta-lib

2. [Optional] Install MongoDB