Skip to content
This repository was archived by the owner on Sep 22, 2020. It is now read-only.

Commit 8f66ad6

Browse files
author
Bernhard Grünewaldt
committed
init
1 parent 33f1940 commit 8f66ad6

1 file changed

Lines changed: 8 additions & 37 deletions

File tree

README.md

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
#### GitHub Pages Basic Auth Proxy by comSysto
44

5+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
6+
7+
58
A simple python based proxy to secure github pages with basic auth via a small cloud-proxy-instance.
69
Basic Auth checks against GitHub API. This little piece of software is brought to you by comSysto.
710
*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
6568

6669
## 2. Installation on Heroku
6770

68-
[![](./doc/heroku-logo.png)](https://dashboard.heroku.com/)
69-
70-
Create a heroku app and clone the git repo. ([Toolbelt is installed](https://toolbelt.heroku.com/) and you are logged in)
71-
72-
```
73-
$> cd ~/
74-
$> heroku create
75-
# Creating app... done, stack is cedar-14
76-
# https://protected-foo-21086.herokuapp.com/ | https://git.heroku.com/protected-foo-21086.git
77-
$> git clone https://git.heroku.com/protected-foo-21086.git heroku-gh-proxy
78-
```
79-
80-
You now have a folder `heroku-gh-proxy` in your homedir that contains the deployed app (currently empty).
81-
Next we clone the GitHub Pages Proxy and extract the latest snapshot into `heroku-gh-proxy` (absolute path needed)
82-
83-
```
84-
$> cd ~/
85-
$> git clone https://github.com/comsysto/github-pages-basic-auth-proxy.git
86-
$> cd github-pages-basic-auth-proxy
87-
$> git checkout-index -a -f --prefix=/Users/bg/heroku-gh-proxy/ # absolute path with trailing slash!
88-
```
89-
90-
Now change the `Procfile` to your repository and obfuscator settings and push.
91-
92-
```
93-
$> cd ~/heroku-gh-proxy
94-
vim Procfile # change your settings
95-
git add . -A
96-
git commit -m "init"
97-
git push
98-
```
99-
100-
Now your app should be up and running.
71+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
10172

102-
* You can access the health check `https://protected-foo-21086.herokuapp.com/health`
103-
* Or directly use the proxy and enter credentials `https://protected-foo-21086.herokuapp.com/`
104-
* A successfully deployed app log should look like this:
105-
* ![](./doc/heroku-logs.png)
73+
You can automatically setup the heroku instance of the proxy by clicking the button above and configure it via `env` vars.
74+
You need to specify `authType`, `owner`, `repository` and `obfuscator`.
10675

76+
IFrame Test:
77+
<iframe width="560" height="315" src="https://comsysto.com" frameborder="0" allowfullscreen></iframe>
10778

10879

10980
## 3. Installation on AWS

0 commit comments

Comments
 (0)