clarify readme

This commit is contained in:
Michael Feng
2023-04-04 16:22:56 -07:00
parent 8405179130
commit 2e27409531
3 changed files with 5 additions and 7 deletions

View File

@@ -1,4 +1,4 @@
# Deploy and Auto-start a single Hummingbot instance with Docker Compose # Auto-Start Hummingbot Instance
This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container and automatically starts running a pre-configured script or strategy. This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container and automatically starts running a pre-configured script or strategy.

View File

@@ -1,4 +1,4 @@
# Deploy: Hummingbot + Gateway # Deploy Hummingbot and Gateway Instances
## How to use it ## How to use it

View File

@@ -1,4 +1,4 @@
# Deploy a single Hummingbot instance with Docker Compose # Deploy Hummingbot Instance
This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container. This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container.
@@ -36,10 +36,8 @@ docker-compose
Usage: docker compose [OPTIONS] COMMAND Usage: docker compose [OPTIONS] COMMAND
``` ```
Clone this repo or copy the `docker-compose.yml` file to a directory on your machine where you want to store your Hummingbot files. This is where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved. Clone this repo or copy the `docker-compose.yml` file to a directory on your machine where you want to store your Hummingbot files. This is where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.
From that directory, run the following command to pull the image and start the instance: From that directory, run the following command to pull the image and start the instance:
``` ```
docker-compose up -d docker-compose up -d
@@ -63,7 +61,7 @@ If installation was successful, you should see the Hummingbot welcome screen:
To get started with Hummingbot, check out the following docs: To get started with Hummingbot, check out the following docs:
* [Basic Features](https://docs.hummingbot.org/operation/) * [Basic Features](https://docs.hummingbot.org/operation/)
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/). * [Quickstart Guide](https://docs.hummingbot.org/quickstart/)
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/) * [Hummingbot FAQ](https://docs.hummingbot.org/faq/)
## Useful Docker Commands ## Useful Docker Commands
@@ -80,7 +78,7 @@ docker-compose up -d
docker attach simple_hummingbot_compose-bot-1 docker attach simple_hummingbot_compose-bot-1
``` ```
### Detach from the instance and return to command line ### Detach from the container and return to command line
Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd> Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>