diff --git a/bash_scripts/gateway-create.sh b/bash_scripts/gateway-create.sh index d74f272..880579b 100755 --- a/bash_scripts/gateway-create.sh +++ b/bash_scripts/gateway-create.sh @@ -10,7 +10,7 @@ echo "ℹ️ Press [ENTER] for default values:" echo echo -read -p "Enter Gateway version you want to use [latest/development] (default = \"latest\") >>> " GATEWAY_TAG +read -p "Enter Gateway version you want to use [latest/latest-arm] (default = \"latest\") >>> " GATEWAY_TAG if [ "$GATEWAY_TAG" == "" ] then GATEWAY_TAG="latest" diff --git a/simple_hummingbot_compose/README.md b/simple_hummingbot_compose/README.md index 04d60c7..d38fe96 100644 --- a/simple_hummingbot_compose/README.md +++ b/simple_hummingbot_compose/README.md @@ -1,16 +1,66 @@ -# Deploy a single Hummingbot instance with docker Compose +# Deploy a single Hummingbot instance with Docker Compose -## How to use it +This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance. -- Make sure you have docker and docker-compose installed. -- Run the following command: - ``` - docker-compose up -d - ``` +## Prerequisites -- Attach the terminal: - ``` - docker attach simple_hummingbot_compose-bot-1 - ``` +This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install Docker Desktop, wihch includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites. -- Now you have Hummingbot running! Remember that you can detach the terminal without stopping the bot by pressing `Ctrl + P` and `Ctrl + Q`. \ No newline at end of file +Docker Desktop is available on: + +* [Linux](https://docs.docker.com/desktop/install/linux-install/) +* [Mac](https://docs.docker.com/desktop/install/mac-install/) +* [Windows](https://docs.docker.com/desktop/install/windows-install/) + +## Installation + +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, and log files will be saved. + +From that directory, run `docker-compose up -d` to pull the image and start the instance. In Terminal/Bash, you should see: + +``` +[+] Running 1/1 + ⠿ Container simple_hummingbot_compose-bot-1 Started + ``` + +After it's running, attach to the instance with `docker attach simple_hummingbot_compose-bot-1`. + +If installation was successful, you should see the Hummingbot welcome screen: + +![welcome screen](../welcome.png) + +Next, explore the Hummingbot [features](https://docs.hummingbot.org/operation/) or follow the [quickstart guide](https://docs.hummingbot.org/quickstart/). + + +## Basic commands + +Use the commands below or use Docker Desktop application to manage your Hummingbot instance: + +Create the instance: +``` +docker-compose up -d +``` + +Attach to the instance: +``` +docker attach simple_hummingbot_compose-bot-1 +``` + +Detach from the instance and return to command line: + +Press keys Ctrl + P then Ctrl + Q + +See all instances: +``` +docker ps -a +``` + +Stop an instance: +``` +docker stop +``` + +Remove an instance: +``` +docker rm +``` diff --git a/simple_hummingbot_compose/docker-compose.yml b/simple_hummingbot_compose/docker-compose.yml index 3bff670..308a583 100644 --- a/simple_hummingbot_compose/docker-compose.yml +++ b/simple_hummingbot_compose/docker-compose.yml @@ -2,6 +2,7 @@ version: "3.9" services: bot: image: hummingbot/hummingbot:latest + # image: hummingbot/hummingbot:latest-arm volumes: - "./hummingbot_files/conf:/conf" - "./hummingbot_files/conf/connectors:/conf/connectors" diff --git a/welcome.png b/welcome.png new file mode 100644 index 0000000..0d00111 Binary files /dev/null and b/welcome.png differ