diff --git a/docs/bot-usage.md b/docs/bot-usage.md index 815fed672..8079d9816 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -9,10 +9,10 @@ it. ## Bot commands ``` -usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME] - [--strategy-path PATH] [--dynamic-whitelist [INT]] - [--dry-run-db] - {backtesting,hyperopt} ... +usage: freqtrade [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME] + [--strategy-path PATH] [--dynamic-whitelist [INT]] + [--db-url PATH] + {backtesting,hyperopt} ... Simple High Frequency Trading Bot for crypto currencies @@ -28,17 +28,16 @@ optional arguments: -c PATH, --config PATH specify configuration file (default: config.json) -d PATH, --datadir PATH - path to backtest data (default: - freqtrade/tests/testdata + path to backtest data -s NAME, --strategy NAME specify strategy class name (default: DefaultStrategy) --strategy-path PATH specify additional strategy lookup path --dynamic-whitelist [INT] dynamically generate and update whitelist based on 24h - BaseVolume (Default 20 currencies) - --dry-run-db Force dry run to use a local DB - "tradesv3.dry_run.sqlite" instead of memory DB. Work - only if dry_run is enabled. + BaseVolume (default: 20) + --db-url PATH Override trades database URL, this is useful if + dry_run is enabled or in custom deployments (default: + sqlite:///tradesv3.sqlite) ``` ### How to use a different config file? @@ -102,14 +101,14 @@ python3 ./freqtrade/main.py --dynamic-whitelist 30 negative value (e.g -2), `--dynamic-whitelist` will use the default value (20). -### How to use --dry-run-db? +### How to use --db-url? When you run the bot in Dry-run mode, per default no transactions are stored in a database. If you want to store your bot actions in a DB -using `--dry-run-db`. This command will use a separate database file -`tradesv3.dry_run.sqlite` +using `--db-url`. This can also be used to specify a custom database +in production mode. Example command: ```bash -python3 ./freqtrade/main.py -c config.json --dry-run-db +python3 ./freqtrade/main.py -c config.json --db-url sqlite:///tradesv3.dry_run.sqlite ``` diff --git a/docs/configuration.md b/docs/configuration.md index 1c4e2b6e1..fe220403d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -34,6 +34,7 @@ The table below will list all configuration parameters. | `telegram.enabled` | true | Yes | Enable or not the usage of Telegram. | `telegram.token` | token | No | Your Telegram bot token. Only required if `telegram.enabled` is `true`. | `telegram.chat_id` | chat_id | No | Your personal Telegram account id. Only required if `telegram.enabled` is `true`. +| `db_url` | `sqlite:///tradesv3.sqlite` | No | Declares database URL to use. NOTE: This defaults to `sqlite://` if `dry_run` is `True`. | `initial_state` | running | No | Defines the initial application state. More information below. | `strategy` | DefaultStrategy | No | Defines Strategy class to use. | `strategy_path` | null | No | Adds an additional strategy lookup path (must be a folder). @@ -111,9 +112,10 @@ creating trades. ### To switch your bot in Dry-run mode: 1. Edit your `config.json` file -2. Switch dry-run to true +2. Switch dry-run to true and specify db_url for a persistent db ```json "dry_run": true, +"db_url": "sqlite///tradesv3.dryrun.sqlite", ``` 3. Remove your Exchange API key (change them by fake api credentials)