From f8d7ba6c5cbb03896e4badb075a70d290ea12781 Mon Sep 17 00:00:00 2001 From: Seth Woodworth Date: Mon, 4 Feb 2013 20:26:49 -0500 Subject: [PATCH] adding intial documentation on the /secrets/ folder, for #50 --- docs/source/secrets.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/source/secrets.rst 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 -- 2.25.1