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

public git URL

This commit is contained in:
Rob Moggach 2018-01-08 20:27:41 -08:00
parent 3d13eb2dc2
commit 732281bca0
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/installation.md
View File

@ -1,7 +1,7 @@
# Install the bot # Install the bot
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 To understand how to set up the bot please read the Bot
[Bot configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) [Bot configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md)
page. page.
## Table of Contents ## Table of Contents
@ -21,14 +21,14 @@ Start by downloading Docker for your platform:
- [Windows](https://www.docker.com/products/docker#/windows) - [Windows](https://www.docker.com/products/docker#/windows)
- [Linux](https://www.docker.com/products/docker#/linux) - [Linux](https://www.docker.com/products/docker#/linux)
Once you have Docker installed, simply create the config file Once you have Docker installed, simply create the config file
(e.g. `config.json`) and then create a Docker image for `freqtrade` (e.g. `config.json`) and then create a Docker image for `freqtrade`
using the Dockerfile in this repo. using the Dockerfile in this repo.
### 1. Prepare the bot ### 1. Prepare the bot
1. Clone the git 1. Clone the git
```bash ```bash
git clone git@github.com:gcarq/freqtrade.git git clone https://github.com/gcarq/freqtrade.git
``` ```
2. (Optional) Checkout the develop branch 2. (Optional) Checkout the develop branch
```bash ```bash
@ -42,7 +42,7 @@ cd freqtrade
```bash ```bash
cp config.json.example config.json cp 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 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) 5. Create your DB file (Optional, the bot will create it if it is missing)
```bash ```bash
# For Production # For Production
@ -60,7 +60,7 @@ 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 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" a sqlite database file (see the "5. Run a restartable docker image"
section) to keep it between updates. section) to keep it between updates.
### 3. Verify the docker image ### 3. Verify the docker image
@ -100,7 +100,7 @@ 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 If you are using `dry_run=True` it's not necessary to mount
`tradesv3.sqlite`, but you can mount `tradesv3.dryrun.sqlite` if you `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`.
@ -116,14 +116,14 @@ 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 # Linux / MacOS
## 1. Requirements ## 1. 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/), - [Python 3.6.x](http://docs.python-guide.org/en/latest/starting/installation/),
note the bot was not tested on Python >= 3.7.x note the bot was not tested on Python >= 3.7.x
- [pip](https://pip.pypa.io/en/stable/installing/) - [pip](https://pip.pypa.io/en/stable/installing/)
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
@ -142,7 +142,7 @@ 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.1.2. Install TA-LIB**
Official webpage: https://mrjbq7.github.io/ta-lib/install.html 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 wget http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
@ -155,7 +155,7 @@ cd ..
rm -rf ./ta-lib* rm -rf ./ta-lib*
``` ```
**2.1.3. [Optional] Install MongoDB** **2.1.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
@ -176,7 +176,7 @@ If you are on a different Linux OS you maybe have to adapt things like:
brew install python3 git wget brew install python3 git wget
``` ```
**2.3.2. [Optional] Install MongoDB** **2.3.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
@ -188,15 +188,15 @@ export PATH=<path_freqtrade>/env/mongodb/bin:$PATH
## 3. Clone the repo ## 3. Clone the repo
The following steps are made for Linux/mac environment The following steps are made for Linux/mac environment
1. Clone the git `git clone git@github.com:gcarq/freqtrade.git` 1. Clone the git `git clone https://github.com/gcarq/freqtrade.git`
2. (Optional) Checkout the develop branch `git checkout develop` 2. (Optional) Checkout the develop branch `git checkout develop`
## 4. Prepare the bot ## 4. Prepare the bot
```bash ```bash
cd freqtrade cd freqtrade
cp config.json.example config.json 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) To edit the config please refer to [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md)
## 5. Setup your virtual env ## 5. Setup your virtual env
```bash ```bash
@ -215,7 +215,7 @@ python3.6 ./freqtrade/main.py -c config.json
``` ```
### Advanced Linux ### Advanced Linux
**systemd service file** **systemd service file**
Copy `./freqtrade.service` to your systemd user directory (usually `~/.config/systemd/user`) Copy `./freqtrade.service` to your systemd user directory (usually `~/.config/systemd/user`)
and update `WorkingDirectory` and `ExecStart` to match your setup. and update `WorkingDirectory` and `ExecStart` to match your setup.
After that you can start the daemon with: After that you can start the daemon with:
@ -224,7 +224,7 @@ systemctl --user start freqtrade
``` ```
# Windows # Windows
We do recommend Windows users to use [Docker](#docker) this will work We do recommend Windows users to use [Docker](#docker) this will work
much easier and smoother (also safer). much easier and smoother (also safer).
```cmd ```cmd
@ -242,5 +242,5 @@ much easier and smoother (also safer).
*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 ## Next step
Now you have an environment ready, the next step is to Now you have an environment ready, the next step is to
[configure your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md). [configure your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md).