From ddfd75c1f894d163fee90ab6d630901149a94557 Mon Sep 17 00:00:00 2001 From: Vivek Santayana Date: Sat, 20 Aug 2022 17:46:45 +0100 Subject: [PATCH] Added selecting database to Readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 558c4fc..4807d9d 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,16 @@ Once in the destination folder, clone all the relevant files you will need for t (Remember to include the trailing dot at the end, as that indicates to Git to download the files in the current directory.) +#### Choose What Database Engine You Will Use + +This app is designed to use an SQLite database by default. +You can set it up to use a MySQL database by configuring the environment variables accordingly. +If your database is being hosted remotely, make sure the MySQL database has the proper authentication for the user from a remote server. +Alternatively, you can also use the second `docker-compose-mysql.yml` file which provides a MySQL database as part of the cluster. +To use the second `docker-compose-mysql.yml` file, use the following command at the last step of the installation: + +```sudo docker compose -f docker-compose-mysql.yml up``` + #### Populate Environment Variables Configuration values for the app are stored in the environment variables file.