Disabled efiling on localdev by default. Added inline documentation to .env.example

.env.example

@@ -1,25 +1,64 @@
+################################################################
+# These settings need to be completed every time you set up a 
+# dev environment
+################################################################
+
+# Set this to your own 30-50 character string with no spaces or
+# punctuation.
+
+DJANGO_SECRET_KEY=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ9876543210
+
+################################################################
+# EFiling is disabled by default.  If you enable it then you'll 
+# need values for EFILING_HUB_KEYCLOAK_SECRET and EFILING_BCEID
+################################################################
+
+# When this is set to False, eFiling will be 'faked' by the
+# Divorce app.
+
+EFILING_HUB_ENABLED=False
+
+
+# This value cannot be entered on Github, and must be obtained
+# from a member of the eDivorce team.
+
+EFILING_HUB_KEYCLOAK_SECRET=
+
+
+# Get the value of "bcgov_userguid" from
+# https://dev.justice.gov.bc.ca/divorce/dashboard/current 
+# You will need VPN access to get to this URL.
+
+EFILING_BCEID=
+
+################################################################
+# You probably won't have to change any settings below this line
+################################################################
+
+# Django settings
 DEBUG=True
 TEMPLATE_DEBUG=True
-DJANGO_SECRET_KEY=
 DATABASE_ENGINE=django.db.backends.sqlite3
 DATABASE_NAME=db.sqlite3
 
 # ClamAV settings
-CLAMAV_ENABLED=True
-CLAMAV_PORT=3310
 CLAMAV_HOST=localhost
+CLAMAV_PORT=3310
+CLAMAV_ENABLED=True
 
 # Redis settings
 REDIS_HOST=localhost
 REDIS_PORT=6379
 REDIS_PASSWORD=admin
 
-# eFiling Hub settings
-EFILING_HUB_KEYCLOAK_BASE_URL=''
-EFILING_HUB_KEYCLOAK_REALM=''
-EFILING_HUB_KEYCLOAK_CLIENT_ID=''
-EFILING_HUB_KEYCLOAK_SECRET=''
-EFILING_HUB_API_BASE_URL=''
+# Keycloak settings
+EDIVORCE_KEYCLOAK_BASE_URL=http://localhost:8081
+EDIVORCE_KEYCLOAK_REALM=justice
 
-# BCE ID test accounts for localdev
-EFILING_BCEID=
+# Weasyprint settings
+WEASYPRINT_URL=http://localhost:5005
+
+# eFiling Hub settings
+EFILING_HUB_KEYCLOAK_BASE_URL=https://dev.oidc.gov.bc.ca
+EFILING_HUB_KEYCLOAK_REALM=tz0e228w
+EFILING_HUB_KEYCLOAK_CLIENT_ID=e-divorce

edivorce/settings/base.py

@@ -182,16 +182,6 @@ DEBUG_TOOLBAR_CONFIG = {
 
 SECURE_BROWSER_XSS_FILTER = True
 
-# eFiling Hub settings
-EFILING_HUB_ENABLED = False
-EFILING_HUB_API_BASE_URL = env('EFILING_HUB_API_BASE_URL', '')
-EFILING_HUB_KEYCLOAK_BASE_URL = env('EFILING_HUB_KEYCLOAK_BASE_URL', '')
-EFILING_HUB_KEYCLOAK_REALM = env('EFILING_HUB_KEYCLOAK_REALM', '')
-EFILING_HUB_KEYCLOAK_CLIENT_ID = env('EFILING_HUB_KEYCLOAK_CLIENT_ID', '')
-EFILING_HUB_KEYCLOAK_SECRET = env('EFILING_HUB_KEYCLOAK_SECRET', '')
-
-EFILING_BCEID = env('EFILING_BCEID', '', subcast=str)
-
 # Keycloak OpenID Connect settings
 # Provided by mozilla-django-oidc
 LOGIN_URL = reverse_lazy('oidc_authentication_init')
@@ -200,4 +190,5 @@ OIDC_RP_SCOPES = 'openid email profile'
 OIDC_RP_CLIENT_SECRET = env('EDIVORCE_KEYCLOAK_SECRET', '')
 OIDC_OP_LOGOUT_URL_METHOD = 'edivorce.apps.core.middleware.keycloak.keycloak_logout'
 
+# eFiling settings
 VIRTUAL_SWEARING_ENABLED = False

edivorce/settings/local.py

@@ -16,7 +16,7 @@ CSRF_COOKIE_AGE = None
 SESSION_COOKIE_AGE = 3600
 TEMPLATES[0]["OPTIONS"]["debug"] = True
 
-WEASYPRINT_URL = 'http://localhost:5005'
+WEASYPRINT_URL = env('WEASYPRINT_URL', 'http://localhost:5005')
 WEASYPRINT_IMAGE_LOOPBACK = 'http://host.docker.internal:8000'
 WEASYPRINT_CSS_LOOPBACK = WEASYPRINT_IMAGE_LOOPBACK
 
@@ -42,8 +42,8 @@ REDIS_PASSWORD = env('REDIS_PASSWORD', '')
 
 # Keycloak OpenID Connect settings
 # Provided by mozilla-django-oidc
-EDIVORCE_KEYCLOAK_BASE_URL = 'http://localhost:8081'
-EDIVORCE_KEYCLOAK_REALM = 'justice'
+EDIVORCE_KEYCLOAK_BASE_URL = env('EDIVORCE_KEYCLOAK_BASE_URL', 'http://localhost:8081')
+EDIVORCE_KEYCLOAK_REALM = env('EDIVORCE_KEYCLOAK_REALM', 'justice')
 KEYCLOAK_LOGOUT = f'{EDIVORCE_KEYCLOAK_BASE_URL}/auth/realms/{EDIVORCE_KEYCLOAK_REALM}/protocol/openid-connect/logout'
 OIDC_OP_JWKS_ENDPOINT = f'{EDIVORCE_KEYCLOAK_BASE_URL}/auth/realms/{EDIVORCE_KEYCLOAK_REALM}/protocol/openid-connect/certs'
 OIDC_OP_AUTHORIZATION_ENDPOINT = f'{EDIVORCE_KEYCLOAK_BASE_URL}/auth/realms/{EDIVORCE_KEYCLOAK_REALM}/protocol/openid-connect/auth'
@@ -52,5 +52,11 @@ OIDC_OP_USER_ENDPOINT = f'{EDIVORCE_KEYCLOAK_BASE_URL}/auth/realms/{EDIVORCE_KEY
 OIDC_RP_CLIENT_ID = 'edivorce-app'
 LOGIN_REDIRECT_URL = '/signin'
 
-EFILING_HUB_ENABLED = True
-VIRTUAL_SWEARING_ENABLED = False
+# eFiling Hub settings
+EFILING_HUB_KEYCLOAK_BASE_URL = env('EFILING_HUB_KEYCLOAK_BASE_URL', '')
+EFILING_HUB_KEYCLOAK_REALM = env('EFILING_HUB_KEYCLOAK_REALM', '')
+EFILING_HUB_KEYCLOAK_CLIENT_ID = env('EFILING_HUB_KEYCLOAK_CLIENT_ID', '')
+EFILING_HUB_KEYCLOAK_SECRET = env('EFILING_HUB_KEYCLOAK_SECRET', '')
+EFILING_HUB_API_BASE_URL = 'https://fla-nginx-proxy-qzaydf-dev.pathfinder.gov.bc.ca/api'
+EFILING_HUB_ENABLED = env.bool('EFILING_HUB_ENABLED', False)
+EFILING_BCEID = env('EFILING_BCEID', '', subcast=str)

edivorce/settings/openshift.py

@@ -127,9 +127,6 @@ REDIS_PORT = 6379
 REDIS_DB = ''
 REDIS_PASSWORD = os.getenv('REDIS_PASSWORD', '')
 
-# Enable virtual swearing
-VIRTUAL_SWEARING_ENABLED = False
-
 
 def monkey_absolutify(request, path):
     return PROXY_BASE_URL + path