From f74f0d5b56d21df31f481b373a16c4ded13fd2bb Mon Sep 17 00:00:00 2001
From: James <mail@jreed.cc>
Date: Sun, 7 Mar 2021 02:01:10 +0000
Subject: [PATCH] Add README.md

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..13b7858
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# mumble-server-aws-terraform-modular
+
+Tested with Terraform v0.13.6.
+
+This will deploy a mumble server (or murmur as it may be) onto an AWS t2.micro instance in the Sydney region, running Fedora 33 x64.
+
+### Updating Cloudflare DNS record to instance public IP address
+*At present, the process to update the Cloudflare DNS zone A record runs on the EC2 instance itself via the startup script (or User Data as AWS call it). It's ideal to have this run locally instead, so that we can avoid any Cloudflare API keys being transported unnecessarily. Essentially, in the way it's been done for the Vultr version of this [here](https://git.jreed.cc/James/mumble-server-vultr-terraform)*
+
+### Deploying
+To deploy this instance, simply issue the following commands:
+```
+terraform init
+terraform plan
+terraform apply
+```
+
+### Destroying and clearing Cloudflare DNS record
+To destroy the environment, simply issue:
+```
+terraform destroy
+```
+
+During this process, Terraform will trigger the ```cloudflare-clear-dns-record.sh``` script. This will simply set the DNS record over at Cloudflare to 127.0.0.1.
-- 
GitLab