Merge pull request #2 from comsysto/heroku-deploy-button

Heroku deploy button with env vars

Author: offboarded-x233534

Procfile

@@ -1 +1 @@
-web: python heroku.py -e heroku -p $PORT --authType allGitHubUsers --owner comsysto --repository github-pages-basic-auth-proxy --obfuscator 086e41eb6ff7a50ad33ad742dbaa2e70b75740c4950fd5bbbdc71981e6fe88e3
+web: python heroku.py -e heroku -p $PORT

README.md

@@ -2,6 +2,9 @@
 
 #### GitHub Pages Basic Auth Proxy by comSysto
 
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
+
+
 A simple python based proxy to secure github pages with basic auth via a small cloud-proxy-instance.
 Basic Auth checks against GitHub API. This little piece of software is brought to you by comSysto.
 *comSysto is not a representative of GitHub. GitHub and the GitHub logos are Trademarks of GitHub inc.* 
@@ -65,45 +68,13 @@ Basic Auth checks against GitHub API. This little piece of software is brought t
 
 ## 2. Installation on Heroku
 
-[![](./doc/heroku-logo.png)](https://dashboard.heroku.com/)
-
-Create a heroku app and clone the git repo. ([Toolbelt is installed](https://toolbelt.heroku.com/) and you are logged in)
-
-```
-$> cd ~/
-$> heroku create
-# Creating app... done, stack is cedar-14
-# https://protected-foo-21086.herokuapp.com/ | https://git.heroku.com/protected-foo-21086.git
-$> git clone https://git.heroku.com/protected-foo-21086.git heroku-gh-proxy
-```
-
-You now have a folder `heroku-gh-proxy` in your homedir that contains the deployed app (currently empty).
-Next we clone the GitHub Pages Proxy and extract the latest snapshot into `heroku-gh-proxy` (absolute path needed)  
-
-```
-$> cd ~/
-$> git clone https://github.com/comsysto/github-pages-basic-auth-proxy.git
-$> cd github-pages-basic-auth-proxy
-$> git checkout-index -a -f --prefix=/Users/bg/heroku-gh-proxy/  # absolute path with trailing slash!
-```
-
-Now change the `Procfile` to your repository and obfuscator settings and push.
-
-```
-$> cd ~/heroku-gh-proxy
-vim Procfile # change your settings
-git add . -A
-git commit -m "init"
-git push
-```
-
-Now your app should be up and running.
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
-  * You can access the health check `https://protected-foo-21086.herokuapp.com/health`
-  * Or directly use the proxy and enter credentials `https://protected-foo-21086.herokuapp.com/` 
-  * A successfully deployed app log should look like this:
-    * ![](./doc/heroku-logs.png)
+You can automatically setup the heroku instance of the proxy by clicking the button above and configure it via `env` vars.
+You need to specify `authType`, `owner`, `repository` and `obfuscator`.
 
+IFrame Test:
+<iframe width="560" height="315" src="https://comsysto.com" frameborder="0" allowfullscreen></iframe>
 
 
 ## 3. Installation on AWS

app.json

@@ -4,5 +4,24 @@
   "image": "heroku/python",
   "repository": "https://github.com/comsysto/github-pages-basic-auth-proxy",
   "keywords": ["python", "gh-pages" ],
-  "addons": [  ]
+  "success_url": "/install-success",
+  "addons": [  ],
+  "env": {
+    "PROXY_AUTH_TYPE": {
+      "description": "The authType. allGitHubUsers or onlyGitHubOrgUsers.",
+      "value": "allGitHubUsers"
+    },
+    "GITHUB_REPOSITORY_OWNER": {
+      "description": "The owner of the GitHub repository you want to proxy",
+      "value": "comsysto"
+    },
+    "GITHUB_REPOSITORY_NAME": {
+      "description": "The name of the GitHub repository you want to proxy",
+      "value": "github-pages-basic-auth-proxy"
+    },
+    "GITHUB_REPOSITORY_OBFUSCATOR": {
+      "description": "The name of the GitHub repository you want to proxy",
+      "value": "086e41eb6ff7a50ad33ad742dbaa2e70b75740c4950fd5bbbdc71981e6fe88e3"
+    }
+  }
 }

cs_proxy/proxy.py

@@ -23,7 +23,7 @@ def main():
     parser.add_argument("-ghr", "--repository", help='the repository name.')
     parser.add_argument("-obf", "--obfuscator", help='the subfolder-name in gh-pages branch used as obfuscator')
     parser.add_argument("-p", "--port", help='the port to run proxy e.g. 8881')
-    parser.add_argument("-a", "--authType", help='how should users auth.', choices=['allGitHubUsers', 'onlyGitHubOrgUsers'] )
+    parser.add_argument("-a", "--authType", help='how should users auth.', choices=['allGitHubUsers', 'onlyGitHubOrgUsers'], required=False )
 
 
     args = parser.parse_args()
@@ -38,6 +38,15 @@ def main():
 
         sys.exit(1)
 
+    if args.environment == 'heroku':
+        args = parser.parse_args(['--environment', 'heroku',
+                                  '--port',       os.environ.get("PORT", 5000),
+                                  '--authType',   os.environ.get("PROXY_AUTH_TYPE", 'allGitHubUsers'),
+                                  '--owner',      os.environ.get("GITHUB_REPOSITORY_OWNER", 'comsysto'),
+                                  '--repository', os.environ.get("GITHUB_REPOSITORY_NAME", 'github-pages-basic-auth-proxy'),
+                                  '--obfuscator', os.environ.get("GITHUB_REPOSITORY_OBFUSCATOR", '086e41eb6ff7a50ad33ad742dbaa2e70b75740c4950fd5bbbdc71981e6fe88e3')
+                                 ])
+
     run_proxy(args)
 
 #
@@ -136,6 +145,10 @@ def error500(error):
     def hello():
         return 'ok'
 
+    @route('/install-success')
+    def hello():
+        return 'The Auth Basic GitHub Pages Proxy was installed successfully.'
+
     #
     # make args available in auth callback
     #
@@ -159,7 +172,7 @@ def proxy_trough_root_page():
     if args.environment == 'wsgi':
         run(host='localhost', port=args.port, debug=True)
     if args.environment == 'heroku':
-        run(host="0.0.0.0", port=int(os.environ.get("PORT", 5000)))
+        run(host="0.0.0.0", port=int(args.port))
     else:
         run(server='cgi')