From f54e72210e45d7578fb1a94ab2ba5144ec2d48a8 Mon Sep 17 00:00:00 2001
From: Max Schmitt <max@schmitt.mx>
Date: Mon, 13 Nov 2017 20:42:12 +0100
Subject: [PATCH] added docs for the example config file

---
 .gitignore        |  4 +---
 build/config.yaml | 14 +++++++-------
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/.gitignore b/.gitignore
index 527e3bb..d18c9a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,12 +12,10 @@
 
 # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
 .glide/
-main.db
-debug
-*db.lock
 
 /config.*
 /handlers/static.go
 /handlers/tmpls/tmpls.go
+/store/main.db
 /releases
 /data
\ No newline at end of file
diff --git a/build/config.yaml b/build/config.yaml
index 20bc995..d0caf89 100644
--- a/build/config.yaml
+++ b/build/config.yaml
@@ -1,11 +1,11 @@
 http:
-  ListenAddr: ':8080'
-  BaseURL: 'http://localhost:3000'
+  ListenAddr: ':8080'              # Consists of 'IP:Port', e.g. ':8080' listens on any IP and on Port 8080
+  BaseURL: 'http://localhost:3000' # Origin URL, required for the authentication via OAuth
 General:
-  DBPath: main.db
-  EnableDebugMode: true
-  ShortedIDLength: 4
+  DataDir: ./data                  # Contains: the database and the private key
+  EnableDebugMode: true            # Activates more detailed logging
+  ShortedIDLength: 4               # Length of the random generated ID which is used for new shortened URLs
 oAuth:
   Google:
-    ClientID: replace me
-    ClientSecret: replace me
+    ClientID: replace me           # ClientID which you get from console.cloud.google.com
+    ClientSecret: replace me       # ClientSecret which get from console.cloud.google.com