From 77377d5e9362bd35a3b300df231e82ee974675e1 Mon Sep 17 00:00:00 2001 From: Parker Berberian Date: Thu, 19 Dec 2019 12:39:01 -0500 Subject: Comments and Documentation This change adds a ton of comments and documentation across all the code. Change-Id: Ifee0a2f534e8584f14b0f13af4dda8dc70eb7553 Signed-off-by: Parker Berberian --- config.env.sample | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'config.env.sample') diff --git a/config.env.sample b/config.env.sample index 7677c2f..44454bb 100644 --- a/config.env.sample +++ b/config.env.sample @@ -2,8 +2,17 @@ DASHBOARD_URL=http://labs.opnfv.org # SECURITY WARNING: don't run with debug turned on in production! DEBUG=False +# TEST should be True if you want to run some tests in your local dev environment TEST=False +# These configure the postgres container and +# tell django how to access the database +# You shouldn't really need to change these, unless +# You want a specific user / pass on the DB +# The POSTGRES_ vars and DB_ vars should be kept in sync, eg +# POSTGRES_DB == DB_NAME +# POSTGRES_USER == DB_USER +# POSTGRES_PASSWORD == DB_PASS POSTGRES_DB=sample_name POSTGRES_USER=sample_user POSTGRES_PASSWORD=sample_pass @@ -19,6 +28,9 @@ SECRET_KEY=http://www.miniwebtool.com/django-secret-key-generator/ OAUTH_CONSUMER_KEY=sample_key OAUTH_CONSUMER_SECRET=sample_secret +# access information for Jira +# In addition to this, the rsa keys from your jira admin +# need to go into src/account JIRA_URL=sample_url JIRA_USER_NAME=sample_jira_user JIRA_USER_PASSWORD=sample_jira_pass @@ -27,7 +39,7 @@ JIRA_USER_PASSWORD=sample_jira_pass RABBITMQ_DEFAULT_USER=opnfv RABBITMQ_DEFAULT_PASS=opnfvopnfv -#Jenkins Build Server +# Jenkins Build Server JENKINS_URL=https://build.opnfv.org/ci # Email Settings -- cgit 1.2.3-korg