Skip to content

Commit

Permalink
Improve install documentation by streamlining the process
Browse files Browse the repository at this point in the history
  • Loading branch information
xmatthias committed Feb 24, 2020
1 parent 23b47b6 commit 2f349e0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
14 changes: 11 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
Expand All @@ -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.
Expand Down
12 changes: 3 additions & 9 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 2f349e0

Please sign in to comment.