Merge pull request #38 from Dr-N0/master

Updated README
This commit is contained in:
Stephen Greene 2020-04-28 15:42:52 -04:00 committed by GitHub
commit 771b817e84
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,10 +1,25 @@
# proxstar
Proxstar
===========
Proxstar is a proxmox VM web management tool used by [Rochester Institute of Technology](https://rit.edu/)'s [Computer Science House](https://csh.rit.edu).
## Overview
Written using [Python](http://nodejs.org), [Flask](https://npmjs.com).
Proxstar removes the need for CSH members to have direct access to the proxmox web interface.
Proxstar is a proxmox VM web management tool used by [Computer Science House](https://csh.rit.edu).
<br>
Written in Python Flask, proxstar removes the need for CSH members to have direct access to the proxmox web
interface.
<br>
Proxstar is also used to enforce proxmox resource limits automagically.
<br>
Available to house members at <code>proxstar.csh.rit.edu</code> behind PYOIDC authentication.
It is available to house members at [proxstar.csh.rit.edu](https://proxstar.csh.rit.edu) behind PYOIDC authentication.
## Contributing
1. [Fork](https://help.github.com/en/articles/fork-a-repo) this repository
- Optionally create a new [git branch](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) if your change is more than a small tweak (`git checkout -b BRANCH-NAME-HERE`)
3. Make your changes locally, commit, and push to your fork
4. Create a [Pull Request](https://help.github.com/en/articles/about-pull-requests) on this repo for our Webmasters to review
## Questions/Concerns
Please file an [Issue](https://github.com/ComputerScienceHouse/proxstar/issues/new) on this repository.