From 9f1de93d482e06e05fc931a11a4ee11135e640f8 Mon Sep 17 00:00:00 2001 From: Yo-An Lin Date: Fri, 13 May 2022 12:31:38 +0800 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bb15a29d..ccd7b577a 100644 --- a/README.md +++ b/README.md @@ -226,6 +226,10 @@ loss correctly. By synchronizing trades and orders to the local database, you can earn some benefits like PnL calculations, backtesting and asset calculation. +You can only use one database driver MySQL or SQLite to store your trading data. + +**Notice**: SQLite is not fully supported, we recommend you use MySQL instead of SQLite. + #### Configure MySQL Database To use MySQL database for data syncing, first you need to install your mysql server: @@ -233,6 +237,9 @@ To use MySQL database for data syncing, first you need to install your mysql ser ```sh # For Ubuntu Linux sudo apt-get install -y mysql-server + +# For newer Ubuntu Linux +sudo apt install -y mysql-server ``` Or [run it in docker](https://hub.docker.com/_/mysql) @@ -252,7 +259,7 @@ DB_DSN="user:password@tcp(127.0.0.1:3306)/bbgo" #### Configure Sqlite3 Database -Just put these environment variables in your `.env.local` file: +To use SQLite3 instead of MySQL, simply put these environment variables in your `.env.local` file: ```sh DB_DRIVER=sqlite3 @@ -272,6 +279,9 @@ To use Redis, first you need to install your Redis server: ```sh # For Ubuntu/Debian Linux sudo apt-get install -y redis + +# For newer Ubuntu/Debian Linux +sudo apt install -y redis ``` Set the following environment variables in your `bbgo.yaml`: