d0zingcat/deploy
1
0
Fork 0
mirror of https://github.com/d0zingcat/deploy.git synced 2026-05-13 23:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

edit readme

Browse Source
This commit is contained in:
Michael Feng
2023-04-04 13:39:01 -07:00
parent 472daa729c
commit 05279307e3
1 changed files with 28 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
simple_hummingbot_compose/README.md
View File

@@ -1,10 +1,10 @@
# Deploy a single Hummingbot instance with Docker Compose
This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance.
This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container.
## Prerequisites
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.
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](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
@@ -16,51 +16,66 @@ Docker Desktop is available on:
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:
From that directory, run the following command to pull the image and start the instance:
```
docker-compose up -d
```
In Terminal/Bash, you should see the following output:
```
[+] 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`.
After it has started, attach to the instance:
```
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/).
To get started with Hummingbot, check out the following docs:
* [Basic Features](https://docs.hummingbot.org/operation/)
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/).
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/)
## Basic commands
## Docker commands
Use the commands below or use Docker Desktop application to manage your Hummingbot instance:
Use the commands below or use the Docker Desktop application to manage your Hummingbot container:
Create the instance:
### Create the container
```
docker-compose up -d
```
Attach to the instance:
### Attach to the container
```
docker attach simple_hummingbot_compose-bot-1
```
Detach from the instance and return to command line:
### Detach from the instance and return to command line
Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
See all instances:
### Update the container to the latest image
```
docker-compose up --force-recreate --build -d
```
### List all containers
```
docker ps -a
```
Stop an instance:
### Stop a container
```
docker stop <instance-name>
```
Remove an instance:
### Remove a container
```
docker rm <instance-name>
```