adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cleaned up installation docs

Browse Source
This commit is contained in:
Rob Moggach 2018-01-12 18:36:12 -08:00
parent 732281bca0
commit d48d2d08df
1 changed files with 178 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

286
docs/installation.md
View File

@ -1,98 +1,118 @@
# Install the bot # Installation
This page explains how to prepare your environment for running the bot. This page explains how to prepare your environment for running the bot.
To understand how to set up the bot please read the Bot
[Bot configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) To understand how to set up the bot please read the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page.
page.
## Table of Contents ## Table of Contents
- [Docker Automatic Installation](#docker)
- [Linux or Mac manual Installation](#linux--mac) * [Docker Automatic Installation](#docker)
* [Linux or Mac Manual Installation](#linux--mac)
- [Linux - Ubuntu 16.04](#21-linux---ubuntu-1604) - [Linux - Ubuntu 16.04](#21-linux---ubuntu-1604)
- [Linux - Other distro](#22-linux---other-distro) - [Linux - Other distro](#22-linux---other-distro)
- [MacOS installation](#23-macos-installation) - [MacOS Installation](#23-macos-installation)
- [Advanced Linux ](#advanced-linux) - [Advanced Linux ](#advanced-linux)
- [Windows manual Installation](#windows) * [Windows manual Installation](#windows)
# Docker
## Easy installation ------
## Automatic Installation - Docker
Start by downloading Docker for your platform: Start by downloading Docker for your platform:
- [Mac](https://www.docker.com/products/docker#/mac)
- [Windows](https://www.docker.com/products/docker#/windows)
- [Linux](https://www.docker.com/products/docker#/linux)
Once you have Docker installed, simply create the config file * [Mac](https://www.docker.com/products/docker#/mac)
(e.g. `config.json`) and then create a Docker image for `freqtrade` * [Windows](https://www.docker.com/products/docker#/windows)
using the Dockerfile in this repo. * [Linux](https://www.docker.com/products/docker#/linux)
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
### 1. Prepare the bot
1. Clone the git
```bash ```bash
git clone https://github.com/gcarq/freqtrade.git git clone https://github.com/gcarq/freqtrade.git
``` ```
2. (Optional) Checkout the develop branch
#### 1.2. (Optional) Checkout the develop branch
```bash ```bash
git checkout develop git checkout develop
``` ```
3. Go into the new directory
#### 1.3. Go into the new directory
```bash ```bash
cd freqtrade cd freqtrade
``` ```
4. Copy `config.sample` to `config.json`
#### 1.4. Copy `config.json.example` to `config.json`
```bash ```bash
cp config.json.example config.json cat config.json.example >> config.json
``` ```
To edit the config please refer to the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page
5. Create your DB file (Optional, the bot will create it if it is missing) > To edit the config please refer to the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page.
#### 1.5. Create your database file *(optional - the bot will create it if it is missing)*
```bash ```bash
# For Production # For Production
touch tradesv3.sqlite touch tradesv3.sqlite
# For Dry-run # For Dry-Run
touch tradesv3.dryrun.sqlite touch tradesv3.dryrun.sqlite
``` ```
### 2. Build the docker image
### 2. Build the Docker image
```bash ```bash
cd freqtrade cd freqtrade
docker build -t freqtrade . docker build -t freqtrade .
``` ```
For security reasons, your configuration file will not be included in the 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.
image, you will need to bind mount it. It is also advised to bind mount
a sqlite database file (see the "5. Run a restartable docker image"
section) to keep it between updates.
### 3. Verify the docker image
After build process you can verify that the image was created with: ### 3. Verify the Docker image
```
After the build process you can verify that the image was created with:
```bash
docker images 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):
``` ### 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):
```bash
docker run --rm -v `pwd`/config.json:/freqtrade/config.json -it freqtrade docker run --rm -v `pwd`/config.json:/freqtrade/config.json -it freqtrade
``` ```
In this example, the database will be created inside the docker instance In this example, the database will be created inside the docker instance and will be lost when you will refresh your image.
and will be lost when you will refresh your image.
### 5. Run a restartable docker 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** 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
```bash ```bash
mkdir ~/.freqtrade mkdir ~/.freqtrade
mv config.json ~/.freqtrade mv config.json ~/.freqtrade
mv tradesv3.sqlite ~/.freqtrade mv tradesv3.sqlite ~/.freqtrade
``` ```
**5.2. Run the docker image** #### 5.2. Run the docker image
```bash ```bash
docker run -d \ docker run -d \
--name freqtrade \ --name freqtrade \
@ -100,12 +120,12 @@ docker run -d \
-v ~/.freqtrade/tradesv3.sqlite:/freqtrade/tradesv3.sqlite \ -v ~/.freqtrade/tradesv3.sqlite:/freqtrade/tradesv3.sqlite \
freqtrade 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 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`.
plan to use the dry run mode with the param `--dry-run-db`.
### 6. Monitor your Docker instance ### 6. Monitor your Docker instance
You can then use the following commands to monitor and manage your container: You can then use the following commands to monitor and manage your container:
```bash ```bash
@ -116,35 +136,42 @@ docker stop freqtrade
docker start freqtrade docker start freqtrade
``` ```
You do not need to rebuild the image for configuration changes, it will You do not need to rebuild the image for configuration changes, it will suffice to edit `config.json` and restart the container.
suffice to edit `config.json` and restart the container.
# Linux / MacOS ------
## 1. Requirements
## 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: Click each one for install guide:
- [Python 3.6.x](http://docs.python-guide.org/en/latest/starting/installation/),
note the bot was not tested on Python >= 3.7.x
- [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)
## 2. First install required packages * [Python 3.6.x](http://docs.python-guide.org/en/latest/starting/installation/), note the bot was not tested on Python >= 3.7.x
This bot require Python 3.6 and TA-LIB * [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)
### 2.1 Linux - Ubuntu 16.04
**2.1.1. Install Python 3.6, Git, and wget** ### Linux - Ubuntu 16.04
#### 1. Install Python 3.6, Git, and wget
```bash ```bash
sudo add-apt-repository ppa:jonathonf/python-3.6 sudo add-apt-repository ppa:jonathonf/python-3.6
sudo apt-get update sudo apt-get update
sudo apt-get install python3.6 python3.6-venv build-essential autoconf libtool pkg-config make wget git sudo apt-get install python3.6 python3.6-venv build-essential autoconf libtool pkg-config make wget git
``` ```
**2.1.2. Install TA-LIB** #### 2. Install TA-Lib
Official webpage: https://mrjbq7.github.io/ta-lib/install.html 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 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 tar xvzf ta-lib-0.4.0-src.tar.gz
cd ta-lib cd ta-lib
@ -155,29 +182,58 @@ cd ..
rm -rf ./ta-lib* rm -rf ./ta-lib*
``` ```
**2.1.3. [Optional] Install MongoDB** #### 3. [Optional] Install MongoDB
Install MongoDB if you plan to optimize your strategy with Hyperopt. Install MongoDB if you plan to optimize your strategy with Hyperopt.
```bash ```bash
sudo apt-get install mongodb-org sudo apt-get install mongodb-org
``` ```
Complete tutorial on [Digital Ocean: How to Install MongoDB on Ubuntu 16.04](https://www.digitalocean.com/community/tutorials/how-to-install-mongodb-on-ubuntu-16-04)
### 2.2. Linux - Other distro > Complete tutorial from Digital Ocean: [How to Install MongoDB on Ubuntu 16.04](https://www.digitalocean.com/community/tutorials/how-to-install-mongodb-on-ubuntu-16-04).
If you are on a different Linux OS you maybe have to adapt things like:
- package manager (for example yum instead of apt-get) #### 4. Install FreqTrade
- package names
### 2.3. MacOS installation Clone the git repository:
**2.3.1. Install Python 3.6, git and wget**
```bash ```bash
brew install python3 git wget git clone https://github.com/gcarq/freqtrade.git
``` ```
**2.3.2. [Optional] Install MongoDB** Optionally checkout the develop branch:
```bash
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:
```bash
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.
```bash
sudo loginctl enable-linger "$USER"
```
### MacOS Installation
#### 1. Install Python 3.6, git, wget and ta-lib
```bash
brew install python3 git wget ta-lib
```
#### 2. [Optional] Install MongoDB
Install MongoDB if you plan to optimize your strategy with Hyperopt. Install MongoDB if you plan to optimize your strategy with Hyperopt.
```bash ```bash
curl -O https://fastdl.mongodb.org/osx/mongodb-osx-ssl-x86_64-3.4.10.tgz curl -O https://fastdl.mongodb.org/osx/mongodb-osx-ssl-x86_64-3.4.10.tgz
tar -zxvf mongodb-osx-ssl-x86_64-3.4.10.tgz tar -zxvf mongodb-osx-ssl-x86_64-3.4.10.tgz
@ -186,46 +242,27 @@ cp -R -n mongodb-osx-x86_64-3.4.10/ <path_freqtrade>/env/mongodb
export PATH=<path_freqtrade>/env/mongodb/bin:$PATH export PATH=<path_freqtrade>/env/mongodb/bin:$PATH
``` ```
## 3. Clone the repo #### 3. Install FreqTrade
The following steps are made for Linux/mac environment
1. Clone the git `git clone https://github.com/gcarq/freqtrade.git`
2. (Optional) Checkout the develop branch `git checkout develop`
## 4. Prepare the bot Clone the git repository:
```bash
cd freqtrade
cp config.json.example config.json
```
To edit the config please refer to [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md)
## 5. Setup your virtual env
```bash
python3.6 -m venv .env
source .env/bin/activate
pip3.6 install -r requirements.txt
pip3.6 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 ```bash
python3.6 ./freqtrade/main.py -c config.json git clone https://github.com/gcarq/freqtrade.git
``` ```
### Advanced Linux Optionally checkout the develop branch:
**systemd service file**
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:
```bash ```bash
systemctl --user start freqtrade git checkout develop
``` ```
# Windows
We do recommend Windows users to use [Docker](#docker) this will work ### Windows
much easier and smoother (also safer).
We recommend that Windows users use [Docker](#docker) as this will work
much easier and smoother (also more secure).
## Install freqtrade
```cmd ```cmd
#copy paste config.json to \path\freqtrade-develop\freqtrade #copy paste config.json to \path\freqtrade-develop\freqtrade
@ -239,8 +276,41 @@ much easier and smoother (also safer).
>cd freqtrade >cd freqtrade
>python main.py >python main.py
``` ```
*Thanks [Owdr](https://github.com/Owdr) for the commands. Source: [Issue #222](https://github.com/gcarq/freqtrade/issues/222)* *Thanks [Owdr](https://github.com/Owdr) for the commands. Source: [Issue #222](https://github.com/gcarq/freqtrade/issues/222)*
## Next step
Now you have an environment ready, the next step is to ------
[configure your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md).
## First Step
```bash
cd freqtrade
cp config.json.example config.json
```
> *To edit the config please refer to [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md).*
### 5. Setup your Python virtual environment (virtualenv)
```bash
python3.6 -m venv .env
source .env/bin/activate
pip3.6 install -r requirements.txt
pip3.6 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
python3.6 ./freqtrade/main.py -c config.json
```
------
## Next Step
Now you have an environment ready, the next step is
[Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md)...