mirror of
https://github.com/d0zingcat/deploy.git
synced 2026-05-19 15:09:58 +00:00
updates
This commit is contained in:
Michael Feng
@@ -6,12 +6,7 @@ This installs a [Hummingbot](https://github.com/hummingbot/hummingbot) instance
|
||||
|
||||
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
|
||||
|
||||
@@ -34,7 +29,14 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
|
||||
|
||||
## Getting Started
|
||||
|
||||
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
|
||||
Installing Hummingbot alongside Gateway lets you access data and execute orders on DEX connectors.
|
||||
|
||||
To enable this, you will do need a few things first:
|
||||
- Install and configure the Hummingbot and Gateway instances
|
||||
- Generate self-signed certificates in Hummingbot
|
||||
- Give Gateway the passphrase used to generate the certificates (`GATEWAY_PASSPHRASE`)
|
||||
|
||||
First, let's check that you have installed Docker Compose successfully. In Terminal/Bash, Run the following command:
|
||||
```
|
||||
docker compose
|
||||
```
|
||||
@@ -44,14 +46,12 @@ 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.
|
||||
|
||||
To link the Hummingbot and Gateway instances, you first have to generate certificates within Hummingbot and set the `GATEWAY_PASSPHRASE` variable in the YAML file.
|
||||
|
||||
|
||||
### 1. Launch network
|
||||
|
||||
Pull the latest Hummingbot and Gateway images and start instances with the following 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 the "root folder" where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.
|
||||
|
||||
|
||||
From the root folder, run the following command to pull the images and start the instance:
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
@@ -66,16 +66,16 @@ After the images have been downloaded, you should see the following output:
|
||||
|
||||
### 2. Set permissions
|
||||
|
||||
Run this command in root directory to grant read/write permission to the `hummingbot_files` and `gateway_files` folders:
|
||||
Run this command from your root folder to grant read/write permission to the `hummingbot_files` and `gateway_files` sub-folders:
|
||||
```
|
||||
sudo chmod -R a+rw ./hummingbot_files ./gateway_files
|
||||
```
|
||||
|
||||
### 3. Generate certificates
|
||||
### 3. Launch Hummingbot and generate certificates
|
||||
|
||||
Now, attach to the Hummingbot `bot` instance:
|
||||
Now, attach to the `hummingbot` instance:
|
||||
```
|
||||
docker attach hummingbot_gateway_compose-bot-1
|
||||
docker attach hummingbot
|
||||
```
|
||||
|
||||
You should see the Hummingbot welcome screen:
|
||||
@@ -84,16 +84,16 @@ You should see the Hummingbot welcome screen:
|
||||
|
||||
Set your Hummingbot [password](https://docs.hummingbot.org/operation/password/) and write it down. This is the `CONFIG_PASSWORD` environment variable in your `docker-compose.yml` file.
|
||||
|
||||
Afterwards, run the following command to generate Gateway certificates:
|
||||
Run the following command to generate Gateway certificates:
|
||||
```
|
||||
gateway generate-certs
|
||||
```
|
||||
|
||||
You'll be prompted for a passphrase used to generate the certificates. This is the `GATEWAY_PASSPHRASE` environment variable in your `docker-compose.yml` file.
|
||||
|
||||
Afterwards, Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
|
||||
Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
|
||||
|
||||
Now, run `exit` to exit the client.
|
||||
Afterwards, run `exit` to exit Hummingbot.
|
||||
|
||||
### 4. Remove network
|
||||
|
||||
@@ -116,7 +116,7 @@ Now, use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docke
|
||||
|
||||
Edit the section that defines the `CONFIG_PASSWORD` and `CONFIG_FILE_NAME` environment variables:
|
||||
```yaml
|
||||
bot:
|
||||
hummingbot:
|
||||
# environment:
|
||||
# - CONFIG_PASSWORD=[password]
|
||||
gateway:
|
||||
@@ -131,7 +131,7 @@ Uncomment out:
|
||||
|
||||
The final `environment` section of the YAML file should look like this:
|
||||
```yaml
|
||||
bot:
|
||||
hummingbot:
|
||||
environment:
|
||||
- CONFIG_PASSWORD=[password]
|
||||
gateway:
|
||||
@@ -148,7 +148,7 @@ Now, recreate the Compose project:
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Attach to the `hummingbot` instance:
|
||||
Attach to the `hummingbot` instance. If you have defined `CONFIG_PASSWORD` in the YAML file, you don't need to enter it again:
|
||||
```
|
||||
docker attach hummingbot
|
||||
```
|
||||
@@ -160,51 +160,8 @@ docker attach gateway
|
||||
```
|
||||
See [Gateway](https://docs.hummingbot.org/gateway/) for more details on how to configure it for use with Hummingbot.
|
||||
|
||||
To get started with Hummingbot, check out the following docs:
|
||||
|
||||
## Useful Docker Commands
|
||||
|
||||
Use the commands below or use the Docker Desktop application to manage your containers:
|
||||
|
||||
### Create/Launch Compose project
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Remove 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 a container
|
||||
```
|
||||
docker attach <container-name>
|
||||
```
|
||||
|
||||
### Detach from a container and return to command line
|
||||
|
||||
* Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
|
||||
|
||||
### List all containers
|
||||
```
|
||||
docker ps -a
|
||||
```
|
||||
|
||||
### Stop a container
|
||||
```
|
||||
docker stop <container-name>
|
||||
```
|
||||
|
||||
### Remove a container
|
||||
```
|
||||
docker rm <container-name>
|
||||
```
|
||||
* [Basic Features](https://docs.hummingbot.org/operation/)
|
||||
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/)
|
||||
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/)
|
||||
|
||||
Reference in New Issue
Block a user