From d2fceff52a49086ab4b89ff21be7b6961fae698b Mon Sep 17 00:00:00 2001
From: Michael Green <84688932+michael-j-green@users.noreply.github.com>
Date: Sun, 2 Jul 2023 21:58:59 +1000
Subject: [PATCH] doc: updated readme

---
 README.MD | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/README.MD b/README.MD
index c303d5c..8b0ee87 100644
--- a/README.MD
+++ b/README.MD
@@ -4,6 +4,7 @@ This is the server for the Gaseous system. All your games and metadata are store
 
 ## Requirements
 * MySQL Server 8+
+* Internet Game Database API Key. See: https://api-docs.igdb.com/#account-creation
 
 ## Third Party Projects
 The following projects are used by Gaseous
@@ -11,3 +12,50 @@ The following projects are used by Gaseous
 * https://github.com/JamesNK/Newtonsoft.Json
 * https://www.nuget.org/packages/MySql.Data/8.0.32.1
 * https://github.com/kamranayub/igdb-dotnet
+
+## Configuration File
+When Gaseous-Server is started for the first time, it creates a configuration file at ~/.gaseous-server/config.json if it doesn't exist. Some values can be filled in using environment variables (such as in the case of using docker).
+
+### DatabaseConfiguration
+| Attribute | Environment Variable |
+| --------- | -------------------- |
+| HostName  | dbhost               |
+| UserName  | dbuser               |
+| Password  | dbpass               |
+
+### IGDBConfiguration
+| Attribute | Environment Variable |
+| --------- | -------------------- |
+| ClientId  | igdbclientid         |
+| Secret.   | igdbclientsecret     |
+
+### config.json
+```json
+{
+  "DatabaseConfiguration": {
+    "HostName": "localhost",
+    "UserName": "gaseous",
+    "Password": "gaseous",
+    "DatabaseName": "gaseous",
+    "Port": 3306
+  },
+  "IGDBConfiguration": {
+    "ClientId": "<clientid>",
+    "Secret": "<secret>"
+  },
+  "LoggingConfiguration": {
+    "DebugLogging": false,
+    "LogFormat": "text"
+  }
+}
+
+```
+
+## Deploy with Docker
+Dockerfile and docker-compose.yml files have been provided to make deployment of the server as easy as possible.
+1. Clone the repo with "git clone https://github.com/gaseous-project/gaseous-server.git"
+2. Change into the gaseous-server directory
+3. Switch to the develop branch with "git checkout develop"
+4. Open the docker-compose.yml file and edit the igdbclientid and igdbclientsecret to the values retrieved from your IGDB account
+5. Run the command "docker-compose up -d"
+6. Connect to the host on port 5198
\ No newline at end of file