From 251b0edbdb76296d0b994eba481d7ab108867173 Mon Sep 17 00:00:00 2001 From: Michael Feng Date: Thu, 4 Apr 2024 07:39:59 -0700 Subject: [PATCH] (fix) resolved conflicts --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++---- docker-compose.yml | 33 +++++++++++++------------------- 2 files changed, 56 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d279a927c4..44a07a5023 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,53 @@ Help us **democratize high-frequency trading** and make powerful trading algorit * [Installation](https://hummingbot.org/installation/): Install Hummingbot on various platforms * [FAQs](https://hummingbot.org/faq/): Answers to all your burning questions * [Botcamp](https://hummingbot.org/botcamp/): Learn how build your own custom HFT strategy in Hummingbot with our hands-on bootcamp! - -## Community - * [Newsletter](https://hummingbot.substack.com): Get our monthly newletter whenever we ship a new release * [Discord](https://discord.gg/hummingbot): The main gathering spot for the global Hummingbot community * [YouTube](https://www.youtube.com/c/hummingbot): Videos that teach you how to get the most of of Hummingbot * [Twitter](https://twitter.com/_hummingbot): Get the latest announcements about Hummingbot -* [Snapshot](https://snapshot.org/#/hbot-prp.eth): Participate in monthly polls that decide which components should be prioritized and included +* [Snapshot](https://snapshot.org/#/hbot-prp.eth): Participate in monthly polls that decide which components should be prioritized + +## Getting Started + +### Install with Docker + +We recommend installing Hummingbot using Docker if you want the simplest, easiest installation method and don't need to modify the Hummingbot codebase. + +**Prerequesites:** + +* MacOS 10.12.6+ / Linux (Ubuntu 20.04+, Debian 10+) / Windows 10+ +* Memory: 4 GB RAM per instance +* Storage: 5 GB HDD space per instance +* Install [Docker Compose](https://docs.docker.com/compose/) + +``` +git clone https://github.com/hummingbot/hummingbot +cd hummingbot +docker compose up -d +docker attach hummingbot +``` + +### Install from Source + +We recommend installing Hummingbot from source if you want to customize or extend the Hummingbot codebase, build new components like connectors or strategies, and/or learn how Hummingbot works at a deeper, technical level. + +**Prerequesites:** + +* MacOS 10.12.6+ / Linux (Ubuntu 20.04+, Debian 10+) +* Memory: 4 GB RAM per instance +* Storage: 3 GB HDD space per instance +* Install [Anaconda](https://www.anaconda.com/download) or [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) + +``` +git clone https://github.com/hummingbot/hummingbot +cd hummingbot +./install +conda activate hummingbot +./compile +./start +``` + +See [Installation](https://hummingbot.org/installation/) for detailed guides for each OS. ## Architecture diff --git a/docker-compose.yml b/docker-compose.yml index ac82395c0c..b31e58c773 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -23,25 +23,18 @@ services: # environment: # - CONFIG_PASSWORD=a # - CONFIG_FILE_NAME=simple_pmm_example.py - - # dashboard: - # container_name: dashboard - # image: hummingbot/dashboard:latest - # volumes: - # - ./data:/home/dashboard/data - # ports: - # - "8501:8501" + # - SCRIPT_CONFIG=conf_simple_pmm_example.yaml # gateway: - # container_name: gateway - # image: hummingbot/gateway:latest - # ports: - # - "15888:15888" - # - "8080:8080" - # volumes: - # - "./gateway_files/conf:/home/gateway/conf" - # - "./gateway_files/logs:/home/gateway/logs" - # - "./gateway_files/db:/home/gateway/db" - # - "./certs:/home/gateway/certs" - # environment: - # - GATEWAY_PASSPHRASE=a \ No newline at end of file + # container_name: gateway + # image: hummingbot/gateway:latest + # ports: + # - "15888:15888" + # - "8080:8080" + # volumes: + # - "./gateway_files/conf:/home/gateway/conf" + # - "./gateway_files/logs:/home/gateway/logs" + # - "./gateway_files/db:/home/gateway/db" + # - "./certs:/home/gateway/certs" + # environment: + # - GATEWAY_PASSPHRASE=a