266 lines
8.9 KiB
Markdown
266 lines
8.9 KiB
Markdown
# Installation
|
||
|
||
This page explains how to prepare your environment for running the bot.
|
||
|
||
## Prerequisite
|
||
|
||
### Requirements
|
||
|
||
Click each one for install guide:
|
||
|
||
* [Python >= 3.6.x](http://docs.python-guide.org/en/latest/starting/installation/)
|
||
* [pip](https://pip.pypa.io/en/stable/installing/)
|
||
* [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
||
* [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended)
|
||
* [TA-Lib](https://mrjbq7.github.io/ta-lib/install.html) (install instructions below)
|
||
|
||
### API keys
|
||
|
||
Before running your bot in production you will need to setup few
|
||
external API. In production mode, the bot will require valid Exchange API
|
||
credentials. We also recommend a [Telegram bot](telegram-usage.md#setup-your-telegram-bot) (optional but recommended).
|
||
|
||
### Setup your exchange account
|
||
|
||
You will need to create API Keys (Usually you get `key` and `secret`) from the Exchange website and insert this into the appropriate fields in the configuration or when asked by the installation script.
|
||
|
||
## Quick start
|
||
|
||
Freqtrade provides a Linux/MacOS script to install all dependencies and help you to configure the bot.
|
||
|
||
!!! Note
|
||
Python3.6 or higher and the corresponding pip are assumed to be available. The install-script will warn and stop if that's not the case.
|
||
|
||
```bash
|
||
git clone git@github.com:freqtrade/freqtrade.git
|
||
cd freqtrade
|
||
git checkout develop
|
||
./setup.sh --install
|
||
```
|
||
|
||
!!! Note
|
||
Windows installation is explained [here](#windows).
|
||
|
||
## Easy Installation - Linux Script
|
||
|
||
If you are on Debian, Ubuntu or MacOS freqtrade provides a script to Install, Update, Configure, and Reset your bot.
|
||
|
||
```bash
|
||
$ ./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: `ta-lib`
|
||
* 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`.
|
||
|
||
------
|
||
|
||
## 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.
|
||
OS Specific steps are listed first, the [Common](#common) section below is necessary for all systems.
|
||
|
||
!!! Note
|
||
Python3.6 or higher and the corresponding pip are assumed to be available.
|
||
|
||
### Linux - Ubuntu 16.04
|
||
|
||
#### Install necessary dependencies
|
||
|
||
```bash
|
||
sudo apt-get update
|
||
sudo apt-get install build-essential git
|
||
```
|
||
|
||
#### Raspberry Pi / Raspbian
|
||
|
||
Before installing FreqTrade on a Raspberry Pi running the official Raspbian Image, make sure you have at least Python 3.6 installed. The default image only provides Python 3.5. Probably the easiest way to get a recent version of python is [miniconda](https://repo.continuum.io/miniconda/).
|
||
|
||
The following assumes that miniconda3 is installed and available in your environment. Since the last miniconda3 installation file uses python 3.4, we will update to python 3.6 on this installation.
|
||
It's recommended to use (mini)conda for this as installation/compilation of `numpy` and `pandas` takes a long time.
|
||
|
||
Additional package to install on your Raspbian, `libffi-dev` required by cryptography (from python-telegram-bot).
|
||
|
||
``` bash
|
||
conda config --add channels rpi
|
||
conda install python=3.6
|
||
conda create -n freqtrade python=3.6
|
||
conda activate freqtrade
|
||
conda install pandas numpy
|
||
|
||
sudo apt install libffi-dev
|
||
python3 -m pip install -r requirements-common.txt
|
||
python3 -m pip install -e .
|
||
```
|
||
|
||
!!! Note
|
||
This does not install hyperopt dependencies. To install these, please use `python3 -m pip install -e .[hyperopt]`.
|
||
We do not advise to run hyperopt on a Raspberry Pi, since this is a very resource-heavy operation, which should be done on powerful machine.
|
||
|
||
### Common
|
||
|
||
#### 1. Install TA-Lib
|
||
|
||
Official webpage: https://mrjbq7.github.io/ta-lib/install.html
|
||
|
||
```bash
|
||
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
|
||
sed -i.bak "s|0.00000001|0.000000000000000001 |g" src/ta_func/ta_utility.h
|
||
./configure --prefix=/usr/local
|
||
make
|
||
sudo make install
|
||
cd ..
|
||
rm -rf ./ta-lib*
|
||
```
|
||
|
||
!!! Note
|
||
An already downloaded version of ta-lib is included in the repository, as the sourceforge.net source seems to have problems frequently.
|
||
|
||
#### 2. Setup your Python virtual environment (virtualenv)
|
||
|
||
!!! Note
|
||
This step is optional but strongly recommended to keep your system organized
|
||
|
||
```bash
|
||
python3 -m venv .env
|
||
source .env/bin/activate
|
||
```
|
||
|
||
#### 3. Install Freqtrade
|
||
|
||
Clone the git repository:
|
||
|
||
```bash
|
||
git clone https://github.com/freqtrade/freqtrade.git
|
||
|
||
```
|
||
|
||
Optionally checkout the master branch to get the latest stable release:
|
||
|
||
```bash
|
||
git checkout master
|
||
```
|
||
|
||
#### 4. Initialize the configuration
|
||
|
||
```bash
|
||
cd freqtrade
|
||
cp config.json.example config.json
|
||
```
|
||
|
||
> *To edit the config please refer to [Bot Configuration](configuration.md).*
|
||
|
||
#### 5. Install python dependencies
|
||
|
||
``` bash
|
||
python3 -m pip install --upgrade pip
|
||
python3 -m pip install -e .
|
||
```
|
||
|
||
#### 6. Run the Bot
|
||
|
||
If this is the first time you run the bot, ensure you are running it in Dry-run `"dry_run": true,` otherwise it will start to buy and sell coins.
|
||
|
||
```bash
|
||
freqtrade -c config.json
|
||
```
|
||
|
||
*Note*: If you run the bot on a server, you should consider using [Docker](docker.md) or a terminal multiplexer like `screen` or [`tmux`](https://en.wikipedia.org/wiki/Tmux) to avoid that the bot is stopped on logout.
|
||
|
||
#### 7. (Optional) Post-installation Tasks
|
||
|
||
On Linux, as an optional post-installation task, you can setup the bot to run as a `systemd` service. See [Advanced Post-installation Tasks](advanced-setup.md) for details.
|
||
|
||
------
|
||
|
||
## Using Conda
|
||
|
||
Freqtrade can also be installed using Anaconda (or Miniconda).
|
||
|
||
``` bash
|
||
conda env create -f environment.yml
|
||
```
|
||
|
||
!!! Note
|
||
This requires the [ta-lib](#1-install-ta-lib) C-library to be installed first.
|
||
|
||
## Windows
|
||
|
||
We recommend that Windows users use [Docker](docker.md) as this will work much easier and smoother (also more secure).
|
||
|
||
If that is not possible, try using the Windows Linux subsystem (WSL) - for which the Ubuntu instructions should work.
|
||
If that is not available on your system, feel free to try the instructions below, which led to success for some.
|
||
|
||
### Install freqtrade manually
|
||
|
||
!!! Note
|
||
Make sure to use 64bit Windows and 64bit Python to avoid problems with backtesting or hyperopt due to the memory constraints 32bit applications have under Windows.
|
||
|
||
!!! Hint
|
||
Using the [Anaconda Distribution](https://www.anaconda.com/distribution/) under Windows can greatly help with installation problems. Check out the [Conda section](#using-conda) in this document.
|
||
|
||
#### Clone the git repository
|
||
|
||
```bash
|
||
git clone https://github.com/freqtrade/freqtrade.git
|
||
```
|
||
|
||
#### Install ta-lib
|
||
|
||
Install ta-lib according to the [ta-lib documentation](https://github.com/mrjbq7/ta-lib#windows).
|
||
|
||
As compiling from source on windows has heavy dependencies (requires a partial visual studio installation), there is also a repository of unofficial precompiled windows Wheels [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#ta-lib), which needs to be downloaded and installed using `pip install TA_Lib‑0.4.17‑cp36‑cp36m‑win32.whl` (make sure to use the version matching your python version)
|
||
|
||
```cmd
|
||
>cd \path\freqtrade-develop
|
||
>python -m venv .env
|
||
>.env\Scripts\activate.bat
|
||
REM optionally install ta-lib from wheel
|
||
REM >pip install TA_Lib‑0.4.17‑cp36‑cp36m‑win32.whl
|
||
>pip install -r requirements.txt
|
||
>pip install -e .
|
||
>freqtrade
|
||
```
|
||
|
||
> Thanks [Owdr](https://github.com/Owdr) for the commands. Source: [Issue #222](https://github.com/freqtrade/freqtrade/issues/222)
|
||
|
||
#### Error during installation under Windows
|
||
|
||
``` bash
|
||
error: Microsoft Visual C++ 14.0 is required. Get it with "Microsoft Visual C++ Build Tools": http://landinghub.visualstudio.com/visual-cpp-build-tools
|
||
```
|
||
|
||
Unfortunately, many packages requiring compilation don't provide a pre-build wheel. It is therefore mandatory to have a C/C++ compiler installed and available for your python environment to use.
|
||
|
||
The easiest way is to download install Microsoft Visual Studio Community [here](https://visualstudio.microsoft.com/downloads/) and make sure to install "Common Tools for Visual C++" to enable building c code on Windows. Unfortunately, this is a heavy download / dependency (~4Gb) so you might want to consider WSL or [docker](docker.md) first.
|
||
|
||
---
|
||
|
||
Now you have an environment ready, the next step is
|
||
[Bot Configuration](configuration.md).
|