Clarifying the comments in the config files.

Author: Taytay

Diff for: nginx.conf

@@ -1,22 +1,22 @@
-## Taytay:
 ## The below contents and nginx_3scale_access.lua are created by 3Scale by
 ## following the steps here:
 ## https://support.3scale.net/howtos/api-configuration/nginx-proxy
 ##
-## (I've taken the generated .conf file and modified it to work on Heroku)
-## You'll replace the contents below with the .conf file that 3Scale gives you
-## Then, you'll make the same minor modifications I did. Just search for
-## 'HEROKU CHANGE:'
-## 3Scale already has some change markers called "NEED CHANGE"
-## You can probably ignore them for the simplest tests
+## A few minor modifications are necessary to get the generated config
+## to work on Heroku. Search for 'HEROKU CHANGE:' in this file and make the same
+## changes to your nginx.conf file
+## Note that 3Scale puts their own change markers in the generated called
+## "NEED CHANGE", so you will see some of those below too.
 
 ## NEED CHANGE (defines the user of the nginx workers)
 # user user group;
 
 ## THIS PARAMETERS BE SAFELY OVER RIDDEN BY YOUR DEFAULT NGINX CONF
 worker_processes  2;
 error_log logs/error.log warn;
-# HEROKU CHANGE: We don't want it running as a daemon, but as a normal process
+
+## HEROKU CHANGE: Add this "daemon off" line to your file so that it runs as a
+## normal process rather than a daemon
 daemon off;
 
 events {
@@ -36,20 +36,23 @@ http {
   }
 
   server {
-    #HEROKU CHANGE: We have to have this placeholder port in here to work on Heroku
+    ## HEROKU CHANGE: Heroku assigns a different port every time, so use this
+    ## placeholder instead of hardcoding it:
     listen ${{PORT}};
 
-    ## HEROKU CHANGE: CHANGE YOUR SERVER NAME TO YOUR CUSTOM DOMAIN OR COMMENT IT OUT IF ONLY HAVE ONE
+    ## CHANGE YOUR SERVER_NAME TO YOUR CUSTOM DOMAIN OR COMMENT IT OUT IF ONLY HAVE ONE
     #server_name api-proxy-3scale-heroku.herokuapp.com;
     underscores_in_headers on;
 
     location = /threescale_authrep {
       internal;
-      ## HEROKU CHANGE: MAKE A HEROKU ENVIRONMENT VARIABLE CALLED 3SCALE_PROVIDER_KEY
-      ## >heroku config:set 3SCALE_PROVIDER_KEY=1239832745abcde...
+      ## HEROKU CHANGE: (OPTIONAL)
       ## 3Scale normally hardcodes the provider_key here, but if you want to avoid
-      ## checking that into source code, you can use Heroku environment variables
-      set $provider_key "${{3SCALE_PROVIDER_KEY}}";
+      ## checking that into source code, you can create a Heroku config
+      ## environment variable called "3SCALE_PROVIDER_KEY" and uncomment the
+      ## following line.
+      #set $provider_key "${{3SCALE_PROVIDER_KEY}}";
+      set $provider_key "hardcoded_secret_3scale_providerkey";
 
       proxy_pass http://threescale_backend/transactions/authrep.xml?provider_key=$provider_key&service_id=$service_id&$usage&$credentials;
       proxy_set_header  Host  su1.3scale.net;
@@ -59,9 +62,9 @@ http {
       internal;
       proxy_pass_request_headers off;
       ##needs to be in both places, better not to have it on location / for potential security issues, req. are internal
-      ## HEROKU CHANGE: MAKE A HEROKU ENVIRONMENT VARIABLE CALLED 3SCALE_PROVIDER_KEY
-      ## >heroku config:set 3SCALE_PROVIDER_KEY=1239832745abcde...
-      set $provider_key "${{3SCALE_PROVIDER_KEY}}";
+      ## HEROKU CHANGE: (OPTIONAL) (see note above)
+      #set $provider_key "${{3SCALE_PROVIDER_KEY}}";
+      set $provider_key "hardcoded_secret_3scale_providerkey";
 
 
       content_by_lua '
@@ -89,15 +92,14 @@ http {
       set $cached_key null;
       set $credentials null;
       set $usage null;
-      ## HEROKU CHANGE: This will be your own service id as told by 3Scale
       set $service_id 1234567890;
       set $proxy_pass null;
       set $secret_token null;
 
       proxy_ignore_client_abort on;
 
-      ## You don't need to change this unless you put the lua file in a different spot
-      ## CHANGE THE PATH TO POINT TO THE RIGHT FILE ON YOUR FILESYSTEM
+      ## HEROKU CHANGE: Make sure you rename the generated .lua file to
+      ## nginx_3scale_access.lua so that this line works:
       access_by_lua_file nginx_3scale_access.lua;
 
       proxy_pass $proxy_pass ;

Diff for: nginx_3scale_access.lua

@@ -1,3 +1,3 @@
 -- This file is generated for you by 3Scale by following the steps here:
 -- https://support.3scale.net/howtos/api-configuration/nginx-proxy
--- Just paste the contents of their generated .lua file in here
+-- Overwrite the contents of this file with their generated .lua file