diff --git a/docs/advanced-setup.md b/docs/advanced-setup.md index b7ab86eac..967beedbd 100644 --- a/docs/advanced-setup.md +++ b/docs/advanced-setup.md @@ -177,7 +177,7 @@ sudo loginctl enable-linger "$USER" If you run the bot as a service, you can use systemd service manager as a software watchdog monitoring freqtrade bot state and restarting it in the case of failures. If the `internals.sd_notify` parameter is set to true in the configuration or the `--sd-notify` command line option is used, the bot will send keep-alive ping messages to systemd -using the sd_notify (systemd notifications) protocol and will also tell systemd its current state (Running or Stopped) +using the sd_notify (systemd notifications) protocol and will also tell systemd its current state (Running or Paused or Stopped) when it changes. The `freqtrade.service.watchdog` file contains an example of the service unit configuration file which uses systemd diff --git a/docs/configuration.md b/docs/configuration.md index f76b9360d..83591ea63 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -266,7 +266,7 @@ Mandatory parameters are marked as **Required**, which means that they are requi | `bot_name` | Name of the bot. Passed via API to a client - can be shown to distinguish / name bots.
*Defaults to `freqtrade`*
**Datatype:** String | `external_message_consumer` | Enable [Producer/Consumer mode](producer-consumer.md) for more details.
**Datatype:** Dict | | **Other** -| `initial_state` | Defines the initial application state. If set to stopped, then the bot has to be explicitly started via `/start` RPC command.
*Defaults to `stopped`.*
**Datatype:** Enum, either `stopped` or `running` +| `initial_state` | Defines the initial application state. If set to stopped, then the bot has to be explicitly started via `/start` RPC command.
*Defaults to `stopped`.*
**Datatype:** Enum, either `running` or `paused` or `stopped` | `force_entry_enable` | Enables the RPC Commands to force a Trade entry. More information below.
**Datatype:** Boolean | `disable_dataframe_checks` | Disable checking the OHLCV dataframe returned from the strategy methods for correctness. Only use when intentionally changing the dataframe and understand what you are doing. [Strategy Override](#parameters-in-the-strategy).
*Defaults to `False`*.
**Datatype:** Boolean | `internals.process_throttle_secs` | Set the process throttle, or minimum loop duration for one bot iteration loop. Value in second.
*Defaults to `5` seconds.*
**Datatype:** Positive Integer diff --git a/docs/rest-api.md b/docs/rest-api.md index 10e4534c0..cea4d2ee9 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -268,6 +268,9 @@ show_config start Start the bot if it's in the stopped state. +pause + Pause the bot if it's in the running state. If triggered on stopped state will handle open positions. + stats Return the stats report (durations, sell-reasons). @@ -333,6 +336,7 @@ All endpoints in the below table need to be prefixed with the base URL of the AP |-----------|--------|--------------------------| | `/ping` | GET | Simple command testing the API Readiness - requires no authentication. | `/start` | POST | Starts the trader. +| `/pause` | POST | Pause the trader. Gracefully handle open trades according to their rules. Do not enter new positions. | `/stop` | POST | Stops the trader. | `/stopbuy` | POST | Stops the trader from opening new trades. Gracefully closes open trades according to their rules. | `/reload_config` | POST | Reloads the configuration file. diff --git a/docs/telegram-usage.md b/docs/telegram-usage.md index c7c434140..7dedd9d51 100644 --- a/docs/telegram-usage.md +++ b/docs/telegram-usage.md @@ -188,7 +188,7 @@ You can create your own keyboard in `config.json`: !!! Note "Supported Commands" Only the following commands are allowed. Command arguments are not supported! - `/start`, `/stop`, `/status`, `/status table`, `/trades`, `/profit`, `/performance`, `/daily`, `/stats`, `/count`, `/locks`, `/balance`, `/stopentry`, `/reload_config`, `/show_config`, `/logs`, `/whitelist`, `/blacklist`, `/edge`, `/help`, `/version`, `/marketdir` + `/start`, `/pause`, `/stop`, `/status`, `/status table`, `/trades`, `/profit`, `/performance`, `/daily`, `/stats`, `/count`, `/locks`, `/balance`, `/stopentry`, `/reload_config`, `/show_config`, `/logs`, `/whitelist`, `/blacklist`, `/edge`, `/help`, `/version`, `/marketdir` ## Telegram commands @@ -200,6 +200,7 @@ official commands. You can ask at any moment for help with `/help`. |----------|-------------| | **System commands** | `/start` | Starts the trader +| `/pause` | Pause the trader. Gracefully handle open trades according to their rules. Do not enter new positions. | `/stop` | Stops the trader | `/stopbuy | /stopentry` | Stops the trader from opening new trades. Gracefully closes open trades according to their rules. | `/reload_config` | Reloads the configuration file @@ -250,6 +251,10 @@ Below, example of Telegram message you will receive for each command. > **Status:** `running` +### /pause + +> **Status:** `paused` + ### /stop > `Stopping trader ...`