From: Seth Woodworth <seth@sethish.com>
Date: Tue, 5 Feb 2013 01:26:49 +0000 (-0500)
Subject: adding intial documentation on the /secrets/ folder, for #50
X-Git-Tag: release-20150131~522^2~6
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=f8d7ba6c5cbb03896e4badb075a70d290ea12781;p=oweals%2Fkarmaworld.git

adding intial documentation on the /secrets/ folder, for #50
---

diff --git a/docs/source/secrets.rst b/docs/source/secrets.rst
new file mode 100644
index 0000000..484a3a5
--- /dev/null
+++ b/docs/source/secrets.rst
@@ -0,0 +1,22 @@
+Storing Secrets
+===============
+
+Secrets are things that we have to specify to our app,
+but do not want to check into source control.
+These are stored as files in `karmaworld/karmaworld/secrets`
+
+
+client_secrets.json
+-------------------
+
+`client_secrets.json` is the api drive authentication with google api services for authenticating the server-side of `gdrive.py` requests. It is generated by google and used in `gdrive.py`.
+
+
+db_settings.py
+--------------
+
+`db_settings.py` stores data about the production database.
+
++ PROD_DB_NAME = "" # is the database name in postgres
++ PROD_DB_USERNAME = "" # is the postgres login username
++ PROD_DB_PASSWORD = "" # is the postgres login user password