From 23b47b66eccb408d56ba0abd6e6e5ab71b8ae3f5 Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 24 Feb 2020 20:11:25 +0100 Subject: [PATCH 1/4] Update install-script documentation and reorder installation steps --- docs/installation.md | 8 ++++---- mkdocs.yml | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 054cafe9b..0feaf509d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -65,11 +65,11 @@ usage: ** --install ** -With this option, the script will install everything you need to run the bot: +With this option, the script will install the bot and most dependencies: +You will need to have git and python3.6+ installed beforehand for this to work. * Mandatory software as: `ta-lib` -* Setup your virtualenv -* Configure your `config.json` file +* Setup your virtualenv under `.env/` This option is a combination of installation tasks, `--reset` and `--config`. @@ -83,7 +83,7 @@ This option will hard reset your branch (only if you are on either `master` or ` ** --config ** -Use this option to configure the `config.json` configuration file. The script will interactively ask you questions to setup your bot and create your `config.json`. +DEPRECATED - use `freqtrade new-config -c config.json` instead. ------ diff --git a/mkdocs.yml b/mkdocs.yml index d53687c64..4e7e6ff75 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,8 @@ site_name: Freqtrade nav: - - About: index.md - - Installation: installation.md + - Home: index.md - Installation Docker: docker.md + - Installation: installation.md - Configuration: configuration.md - Strategy Customization: strategy-customization.md - Stoploss: stoploss.md From 2f349e0504d014e01f428e8fc0b6e8f8a619aeef Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 24 Feb 2020 20:21:25 +0100 Subject: [PATCH 2/4] Improve install documentation by streamlining the process --- docs/configuration.md | 14 +++++++++++--- docs/installation.md | 12 +++--------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 0b9519688..234ff49ba 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -626,6 +626,11 @@ In production mode, the bot will engage your money. Be careful, since a wrong strategy can lose all your money. Be aware of what you are doing when you run it in production mode. +### Setup your exchange account + +You will need to create API Keys (usually you get `key` and `secret`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the installation script. +API Keys are usually only required for real / production trading, but are not required for paper-trading / dry-run. + ### To switch your bot in production mode **Edit your `config.json` file.** @@ -647,11 +652,14 @@ you run it in production mode. } ``` -!!! Note - If you have an exchange API key yet, [see our tutorial](installation.md#setup-your-exchange-account). - You should also make sure to read the [Exchanges](exchanges.md) section of the documentation to be aware of potential configuration details specific to your exchange. +### Setup your exchange account + +You will need to create API Keys (usually you get `key` and `secret`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the installation script. +API Keys are usually only required for real / production trading, but are not required for paper-trading / dry-run. + + ### Using proxy with Freqtrade To use a proxy with freqtrade, add the kwarg `"aiohttp_trust_env"=true` to the `"ccxt_async_kwargs"` dict in the exchange section of the configuration. diff --git a/docs/installation.md b/docs/installation.md index 0feaf509d..5a15be234 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,6 +2,8 @@ This page explains how to prepare your environment for running the bot. +Please consider using the prebuilt [docker images](docker.md) to get started quickly while trying out freqtrade. + ## Prerequisite ### Requirements @@ -14,15 +16,7 @@ Click each one for install guide: * [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. + We also recommend a [Telegram bot](telegram-usage.md#setup-your-telegram-bot), which is optional but recommended. ## Quick start From a29653b510722251debc426981e3afc1d9929a4d Mon Sep 17 00:00:00 2001 From: Matthias Date: Wed, 26 Feb 2020 08:59:27 +0100 Subject: [PATCH 3/4] Wording changes to install docs Co-Authored-By: hroff-1902 <47309513+hroff-1902@users.noreply.github.com> --- docs/configuration.md | 4 ++-- docs/installation.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 234ff49ba..3844f2812 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -656,8 +656,8 @@ You should also make sure to read the [Exchanges](exchanges.md) section of the d ### Setup your exchange account -You will need to create API Keys (usually you get `key` and `secret`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the installation script. -API Keys are usually only required for real / production trading, but are not required for paper-trading / dry-run. +You will need to create API Keys (usually you get `key` and `secret`, some exchanges supply it with `password`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the installation script. +API Keys are usually only required for live trade (trading for real money, bot running in the "production mode", executing real orders on the exchange) and are not required for the bot running in the dry-run (trade simulation) mode. When you setup the bot in the dry-run mode, you may fill these fields with empty values. ### Using proxy with Freqtrade diff --git a/docs/installation.md b/docs/installation.md index 5a15be234..88e2ef6eb 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,7 +2,7 @@ This page explains how to prepare your environment for running the bot. -Please consider using the prebuilt [docker images](docker.md) to get started quickly while trying out freqtrade. +Please consider using the prebuilt [docker images](docker.md) to get started quickly while trying out freqtrade evaluating how it operates. ## Prerequisite From 8ae0f99a960fa4e7bdb615fa19c29fac887cb9e8 Mon Sep 17 00:00:00 2001 From: Matthias Date: Wed, 26 Feb 2020 09:05:48 +0100 Subject: [PATCH 4/4] Remove duplicate section --- docs/configuration.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 3844f2812..e0dc43f5d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -628,8 +628,8 @@ you run it in production mode. ### Setup your exchange account -You will need to create API Keys (usually you get `key` and `secret`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the installation script. -API Keys are usually only required for real / production trading, but are not required for paper-trading / dry-run. +You will need to create API Keys (usually you get `key` and `secret`, some exchanges require an additional `password`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the `freqtrade new-config` command. +API Keys are usually only required for live trading (trading for real money, bot running in "production mode", executing real orders on the exchange) and are not required for the bot running in dry-run (trade simulation) mode. When you setup the bot in dry-run mode, you may fill these fields with empty values. ### To switch your bot in production mode @@ -654,12 +654,6 @@ API Keys are usually only required for real / production trading, but are not re You should also make sure to read the [Exchanges](exchanges.md) section of the documentation to be aware of potential configuration details specific to your exchange. -### Setup your exchange account - -You will need to create API Keys (usually you get `key` and `secret`, some exchanges supply it with `password`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the installation script. -API Keys are usually only required for live trade (trading for real money, bot running in the "production mode", executing real orders on the exchange) and are not required for the bot running in the dry-run (trade simulation) mode. When you setup the bot in the dry-run mode, you may fill these fields with empty values. - - ### Using proxy with Freqtrade To use a proxy with freqtrade, add the kwarg `"aiohttp_trust_env"=true` to the `"ccxt_async_kwargs"` dict in the exchange section of the configuration.