revise simple compose

This commit is contained in:
Michael Feng
2023-04-08 09:58:09 -07:00
parent 54866886f1
commit 8341263284
6 changed files with 50 additions and 43 deletions

View File

@@ -31,7 +31,7 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
```
docker-compose
docker compose
```
You should see a response that start with:
@@ -52,7 +52,7 @@ Auto-starting a script/strategy lets you start a bot from the command line, skip
Pull the latest Hummingbot image and start it with the following command:
```
docker-compose up -d
docker compose up -d
```
After the images have been downloaded, you should see the following output:
@@ -119,7 +119,7 @@ Afterwards, save the file.
Now, the script or strategy will auto-start when you restart the Compose project
```
docker-compose up -d
docker compose up -d
```
You can attach to the container to inspect it running:
@@ -132,19 +132,19 @@ docker attach autostart_hummingbot_compose-bot-1
Use the commands below or use the Docker Desktop application to manage your containers:
### Create/launch Compose project
### Create/Launch Compose project
```
docker-compose up -d
docker compose up -d
```
### Remove the Compose project
```
docker-compose down
docker compose down
```
### Update the Compose project for the latest images
```
docker-compose up --force-recreate --build -d
docker compose up --force-recreate --build -d
```
### Give all users read/write permissions to local files
@@ -167,13 +167,6 @@ docker ps -a
```
### Stop a container
```
docker-compose down
```
or:
```
docker stop <instance-name>
```

View File

@@ -38,7 +38,7 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
```
docker-compose
docker compose
```
You should see a response that start with:
@@ -54,7 +54,7 @@ To link the Hummingbot and Gateway instances, you first have to generate certifi
Pull the latest Hummingbot and Gateway images and start instances with the following command:
```
docker-compose up -d
docker compose up -d
```
After the images have been downloaded, you should see the following output:
@@ -92,7 +92,7 @@ Now, run `exit` to exit the client.
Once you're back in Bash/Terminal, run the following command to remove the Compose project:
```
docker-compose down
docker compose down
```
You should see the following output:
@@ -138,7 +138,7 @@ Afterwards, save the file.
Now, recreate the Compose project:
```
docker-compose up -d
docker compose up -d
```
Attach to the Hummingbot `bot` instance:
@@ -171,17 +171,17 @@ Use the commands below or use the Docker Desktop application to manage your cont
### Create/Launch Compose project
```
docker-compose up -d
docker compose up -d
```
### Remove the Compose project
```
docker-compose down
docker compose down
```
### Update the Compose project for the latest images
```
docker-compose up --force-recreate --build -d
docker compose up --force-recreate --build -d
```
### Give all users read/write permissions to local files

View File

@@ -36,7 +36,7 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
```
docker-compose
docker compose
```
You should see a response that start with:
@@ -52,7 +52,7 @@ To link the Hummingbot and Gateway instances, you first have to generate certifi
Pull the latest Hummingbot and Gateway images and start instances with the following command:
```
docker-compose up -d
docker compose up -d
```
After the images have been downloaded, you should see the following output:
@@ -89,7 +89,7 @@ Now, run `exit` to exit the client.
Once you're back in Bash/Terminal, run the following command to remove the Compose project:
```
docker-compose down
docker compose down
```
You should see the following output:
@@ -134,7 +134,7 @@ Afterwards, save the file.
Now, recreate the Compose project:
```
docker-compose up -d
docker compose up -d
```
Attach to the Hummingbot `bot` instance:
@@ -156,17 +156,17 @@ Use the commands below or use the Docker Desktop application to manage your cont
### Create/Launch Compose project
```
docker-compose up -d
docker compose up -d
```
### Remove the Compose project
```
docker-compose down
docker compose down
```
### Update the Compose project for the latest images
```
docker-compose up --force-recreate --build -d
docker compose up --force-recreate --build -d
```
### Give all users read/write permissions to local files
@@ -194,7 +194,6 @@ docker ps -a
```
### Stop a container
```
docker stop <instance-name>
```

View File

@@ -36,7 +36,7 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
```
docker-compose
docker compose
```
You should see a response that start with:
@@ -52,7 +52,7 @@ To link the Hummingbot and Gateway instances, you first have to generate certifi
Pull the latest Hummingbot and Gateway images and start instances with the following command:
```
docker-compose up -d
docker compose up -d
```
After the images have been downloaded, you should see the following output:
@@ -90,7 +90,7 @@ Now, run `exit` to exit the client.
Once you're back in Bash/Terminal, run the following command to remove the Compose project:
```
docker-compose down
docker compose down
```
You should see the following output:
@@ -143,7 +143,7 @@ Afterwards, save the file.
Now, recreate the Compose project:
```
docker-compose up -d
docker compose up -d
```
Attach to the `bot` Hummingbot instance. Note that since you have defined `CONFIG_PASSWORD` in the YAML file, you don't need to enter it again:
@@ -170,17 +170,17 @@ Use the commands below or use the Docker Desktop application to manage your cont
### Create/Launch Compose project
```
docker-compose up -d
docker compose up -d
```
### Remove the Compose project
```
docker-compose down
docker compose down
```
### Update the Compose project for the latest images
```
docker-compose up --force-recreate --build -d
docker compose up --force-recreate --build -d
```
### Give all users read/write permissions to local files

View File

@@ -31,7 +31,7 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
```
docker-compose
docker compose
```
You should see a response that start with:
@@ -39,7 +39,14 @@ You should see a response that start with:
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.
### 1. Launch network
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.
From that directory, run the following command to pull the image and start the instance:
```
@@ -49,18 +56,25 @@ docker-compose up -d
After the images have been downloaded, you should see the following output:
```
[+] Running 1/1
⠿ Container simple_hummingbot_compose-bot-1 Started
⠿ Container hummingbot Started
```
Attach to the instance:
```
docker attach simple_hummingbot_compose-bot-1
docker attach hummingbot
```
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/)
@@ -93,7 +107,7 @@ sudo chmod 666 *.*
### Attach to the container
```
docker attach simple_hummingbot_compose-bot-1
docker attach <container-name>
```
### Detach from the container and return to command line
@@ -113,10 +127,10 @@ docker ps -a
### Stop a container
```
docker stop <instance-name>
docker stop <container-name>
```
### Remove a container
```
docker rm <instance-name>
docker rm <container-name>
```

View File

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