This commit is contained in:
Michael Feng
2023-04-17 15:15:50 -07:00
parent bb92f3cf4b
commit 1e2be4b96f
12 changed files with 269 additions and 426 deletions

View File

@@ -6,12 +6,7 @@ This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) in
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:
* [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/)
See [Docker](../DOCKER.md) for more information about how to install and use Docker Compose, as well as helpful commands.
## Apple M1/M2 and other ARM machines
@@ -46,9 +41,9 @@ Clone this repo to your machine:
git clone https://github.com/hummingbot/deploy-examples.git
```
Alternatively, 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.
Alternatively, copy the `docker-compose.yml` file to a directory on your machine where you want to store your Hummingbot files. This is the "root folder" 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 the root folder, run the following command to pull the image and start the instance:
```
docker compose up -d
```
@@ -59,7 +54,16 @@ After the images have been downloaded, you should see the following output:
⠿ Container hummingbot Started
```
Attach to the instance:
### 2. Set permissions
Run this command from your root folder to grant read/write permission to the `hummingbot_files` sub-folder:
```
sudo chmod -R a+rw ./hummingbot_files
```
### 3. Launch Hummingbot
Attach to the `hummingbot` instance:
```
docker attach hummingbot
```
@@ -68,69 +72,9 @@ You should see the Hummingbot welcome screen:
![welcome screen](../welcome.png)
### 2. Set permissions
Run this command in root directory to grant read/write permission to the `hummingbot_files` folder:
```
sudo chmod -R a+rw ./hummingbot_files
```
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/)
## Useful Docker Commands
Use the commands below or use the Docker Desktop application to manage your containers:
### Create the Compose project
```
docker compose up -d
```
### Stop the Compose project
```
docker compose down
```
### Update the Compose project for the latest images
```
docker compose up --force-recreate --build -d
```
### Give all users read/write permissions to local files
```
sudo chmod 666 *.*
```
### Attach to the container
```
docker attach <container-name>
```
### Detach from the container and return to command line
Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### Update the container to the latest image
```
docker compose up --force-recreate --build -d
```
### List all containers
```
docker ps -a
```
### Stop a container
```
docker stop <container-name>
```
### Remove a container
```
docker rm <container-name>
```

View File

@@ -1,6 +1,6 @@
version: "3.9"
services:
bot:
hummingbot:
container_name: "hummingbot"
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm