From bdb006bb35a14c54789ebda439a59b989ffbd0b9 Mon Sep 17 00:00:00 2001
From: mel-byond <75690100+mel-byond@users.noreply.github.com>
Date: Thu, 7 Jan 2021 10:45:07 +0200
Subject: [PATCH] Add config/docker folder, add README.md and an example
 mysql.env file there

---
 config/docker/README.md         | 39 +++++++++++++++++++++++++++++++++
 config/docker/mysql.env.example |  8 +++++++
 2 files changed, 47 insertions(+)
 create mode 100644 config/docker/README.md
 create mode 100644 config/docker/mysql.env.example

diff --git a/config/docker/README.md b/config/docker/README.md
new file mode 100644
index 00000000000..1a5ddffbbfb
--- /dev/null
+++ b/config/docker/README.md
@@ -0,0 +1,39 @@
+## How to set-up the Docker database
+
+
+First, open `config/docker/mysql.env.example`, open in notepad or N++, change all the values to something else ~~or don't if you are lazy~~ for security sake.
+
+Then proceed to save the changed version to `mysql.env` and save it in the same directory as the `mysql.env.example` file.
+
+In order to get docker to use the database, it's suggested to change the `config/dbconfig.txt` to include the values in `.env` file, to do this, use the hostname `db` as host!
+
+### Example for `config/dbconfig.txt`:
+
+```
+# MySQL Connection Configuration
+
+# Server the MySQL database can be found at
+# Examples: localhost, 200.135.5.43, www.mysqldb.com, etc.
+ADDRESS db
+
+# MySQL server port (default is 3306)
+PORT 3306
+
+# Database the population, death, karma, etc. tables may be found in
+DATABASE virgo
+
+# Username/Login used to access the database
+LOGIN sillyusername
+
+# Password used to access the database
+PASSWORD somekindofpassword
+
+# The following information is for feedback tracking via the blackbox server
+FEEDBACK_DATABASE test
+FEEDBACK_LOGIN mylogin
+FEEDBACK_PASSWORD mypassword
+
+# Track population and death statistics
+# Comment this out to disable
+#ENABLE_STAT_TRACKING
+```
\ No newline at end of file
diff --git a/config/docker/mysql.env.example b/config/docker/mysql.env.example
new file mode 100644
index 00000000000..f9eb87493ce
--- /dev/null
+++ b/config/docker/mysql.env.example
@@ -0,0 +1,8 @@
+# MySQL database root password
+db_password=SUPERSEKRETOMYGOD
+# MySQL database name
+db_name=virgo
+# MySQL login username
+dbuser_username=sillyusername
+# MySQL login password
+dbuser_password=somekindofpassword
\ No newline at end of file