Merge pull request #2970 from freqtrade/install_docs

simplify installation documentation
This commit is contained in:
hroff-1902 2020-02-26 11:48:51 +03:00 committed by GitHub
commit 297e63de0a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 18 deletions

View File

@ -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 strategy can lose all your money. Be aware of what you are doing when
you run it in production mode. you run it in production mode.
### Setup your exchange account
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 ### To switch your bot in production mode
**Edit your `config.json` file.** **Edit your `config.json` file.**
@ -647,9 +652,6 @@ 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. 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.
### Using proxy with Freqtrade ### Using proxy with Freqtrade

View File

@ -2,6 +2,8 @@
This page explains how to prepare your environment for running the bot. 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 evaluating how it operates.
## Prerequisite ## Prerequisite
### Requirements ### Requirements
@ -14,15 +16,7 @@ Click each one for install guide:
* [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended) * [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended)
* [TA-Lib](https://mrjbq7.github.io/ta-lib/install.html) (install instructions below) * [TA-Lib](https://mrjbq7.github.io/ta-lib/install.html) (install instructions below)
### API keys We also recommend a [Telegram bot](telegram-usage.md#setup-your-telegram-bot), which is optional but recommended.
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 ## Quick start
@ -65,11 +59,11 @@ usage:
** --install ** ** --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` * Mandatory software as: `ta-lib`
* Setup your virtualenv * Setup your virtualenv under `.env/`
* Configure your `config.json` file
This option is a combination of installation tasks, `--reset` and `--config`. This option is a combination of installation tasks, `--reset` and `--config`.
@ -83,7 +77,7 @@ This option will hard reset your branch (only if you are on either `master` or `
** --config ** ** --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.
------ ------

View File

@ -1,8 +1,8 @@
site_name: Freqtrade site_name: Freqtrade
nav: nav:
- About: index.md - Home: index.md
- Installation: installation.md
- Installation Docker: docker.md - Installation Docker: docker.md
- Installation: installation.md
- Configuration: configuration.md - Configuration: configuration.md
- Strategy Customization: strategy-customization.md - Strategy Customization: strategy-customization.md
- Stoploss: stoploss.md - Stoploss: stoploss.md