update docs - environment variable in use for production

jazkarta · Oct 28, 2022 · bc97803 · bc97803
1 parent 3f9895f
commit bc97803
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 15 deletions.
diff --git a/README.rst b/README.rst
@@ -154,7 +154,22 @@ This control panel allows configuration of:
 - Optional Taxjar API token
 - Optional after-checkout callback URL
 
-jazkarta.shop requires the environment variable ``JAZKARTA_SHOP_ENV`` to be set to ``production`` when it is running in production mode.
+jazkarta.shop requires the environment variable ``JAZKARTA_SHOP_PRODUCTION`` to be set to ``True`` when it is running in production mode. eg:
+
+    [buildout]
+
+    ...
+
+    parts +=
+        client1
+
+    [client1]
+
+    ...
+
+    environment-vars +=
+        JAZKARTA_SHOP_PRODUCTION True
+
 
 Jazkarta Shop Shipping Methods
 ------------------------------

diff --git a/jazkarta/shop/interfaces.py b/jazkarta/shop/interfaces.py
@@ -213,15 +213,15 @@ class ISettings(model.Schema):
 
     stripe_api_key_production = schema.TextLine(
         title=u'Stripe Secret Key (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )
 
     stripe_pub_key_production = schema.TextLine(
         title=u'Stripe Publishable Key (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )
 
@@ -242,22 +242,22 @@ class ISettings(model.Schema):
 
     authorizenet_api_login_id_production = schema.TextLine(
         title=u'Authorize.Net API Login ID (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )
 
     authorizenet_transaction_key_production = schema.TextLine(
         title=u'Authorize.Net Transaction Key (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )
 
     authorizenet_signature_key_production = schema.TextLine(
         title=u'Authorize.Net Signature Key (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )
 
@@ -268,8 +268,8 @@ class ISettings(model.Schema):
 
     authorizenet_sim_url_production = schema.TextLine(
         title=u'Authorize.Net SIM URL (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )
 
@@ -286,8 +286,8 @@ class ISettings(model.Schema):
 
     authorizenet_client_key_production = schema.TextLine(
         title=u'Authorize.Net Client Key (Production)',
-        description=u"This key will be used when the JAZKARTA_SHOP_ENV "
-                    u"environment variable equals 'production'.",
+        description=u"This key will be used when the JAZKARTA_SHOP_PRODUCTION "
+                    u"environment variable equals 'True'.",
         required=False,
     )