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

Commit 893ffca

Browse files
roadmap
1 parent 20a112e commit 893ffca

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ A simple python based proxy to secure github pages with basic auth via a small c
66
Basic Auth checks against GitHub API. This little piece of software is brought to you by comSysto.
77
*comSysto is not a representative of GitHub. GitHub and the GitHub logos are Trademarks of GitHub inc.*
88

9+
**TOC**
10+
* [1. Introduction](#1-introduction)
11+
* [2. Installation](#2-installation)
12+
* [3. Roadmap](#3-roadmap)
13+
* [4. License](#4-license)
14+
915
## 1. Introduction
1016

1117
:bangbang: **BETA: THIS IS WORKING BUT NOT RECOMMENDED FOR PRODUCTION USE!** :bangbang:
@@ -118,6 +124,17 @@ $> cs-gh-proxy -e wsgi -p 8881 --authType allGitHubUsers --owner comsysto --repo
118124
* put run command (see above) in script
119125
* run as daemon with `/usr/local/sbin/daemonize /opt/run-gh-proxy.sh`
120126

121-
# License
127+
# 3. Roadmap
128+
129+
* Provide oAuth instead of Basic Auth
130+
* Enable CORS
131+
* Enable on-the-fly GZIP compression
132+
* Enable caching (maybe replace internal proxy mechanism with WSGIproxy)
133+
* Real logging
134+
* Provide Ubuntu init Scripts
135+
* Provide Heroku easy install
136+
137+
138+
# 4. License
122139

123-
Licensed under [MIT License](./LICENSE.md)
140+
Licensed under [MIT License](./LICENSE.md)

0 commit comments

Comments
 (0)