From 24a4ad52c04b4ba6bb17ed12ed8a4f23a0535e65 Mon Sep 17 00:00:00 2001
From: Darius Kazemi <darius.kazemi@gmail.com>
Date: Mon, 25 Mar 2019 21:08:40 -0700
Subject: [PATCH] Make it so config.json is not checked in

---
 .gitignore           | 1 +
 README.md            | 6 +++++-
 config-template.json | 8 ++++++++
 3 files changed, 14 insertions(+), 1 deletion(-)
 create mode 100644 config-template.json

diff --git a/.gitignore b/.gitignore
index 4913e17..8d3e807 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 node_modules/
 package-lock.json
 *.db
+config.json
diff --git a/README.md b/README.md
index 6ed1d15..3dbf993 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,10 @@ Clone the repository, then `cd` into its root directory. Install dependencies:
 
 `npm i`
 
+Copy `config-template.json` to `config.json`.
+
+`cp config-template.json config.json`
+
 Update your `config.json` file:
 
 ```js
@@ -45,7 +49,7 @@ Enter "test" in the "Create Account" section and hit the "Create Account" button
 
 ## Local testing
 
-You can use a service like [ngrok](https://ngrok.com/) to test things out before you deploy on a real server. All you need to do is install ngrok and run `ngrok http 3000` (or whatever port you're using if you changed it). Then go to your `config.json` and update the `DOMAIN` field to whatever `abcdef.ngrok.io` domain that ngrok gives you and restart your server.
+You can use a service like [ngrok](https://ngrok.com/) to test things out before you deploy on a real server. All you need to do is install ngrok and run `ngrok http 3000` (or whatever port you're using if you changed it). Then go to your `config.json` and update the `DOMAIN` field to whatever `abcdef.ngrok.io` domain that ngrok gives you and restart your server. *For local testing you do not need to specify `PRIVKEY_PATH` or `CERT_PARTH`.*
 
 ## Admin Page
 
diff --git a/config-template.json b/config-template.json
new file mode 100644
index 0000000..a1c50a4
--- /dev/null
+++ b/config-template.json
@@ -0,0 +1,8 @@
+{
+  "USER": "",
+  "PASS": "",
+  "DOMAIN": "",
+  "PORT": "3000",
+  "PRIVKEY_PATH": "",
+  "CERT_PATH": ""
+}