updated readme

Author: hakasapl

Diff for: CONTRIBUTING.md

@@ -6,6 +6,10 @@ Each release version has its own branch. Once that version is released, the bran
 
 When submitting pull requests, the pull request should be made to the version you are targetting, assuming it is not already released.
 
+## Conventions
+
+This code base is currently using PHP version 7.4. All files are required to be linted with PSR-12 standard. This repository will automatically check PRs for linting compliance.
+
 ## Development Environment
 
 ### Setting up your Environment

Diff for: README.md

@@ -1,8 +1,19 @@
 ![alt text](https://user-images.githubusercontent.com/40907639/137608695-2d914da2-1ecc-480b-a47e-a9e33b2b1b45.png)
 
-## Unity Cluster Web Portal ##
-
-### Installation ###
+# Unity Web Portal
+Unity Web Portal is a PHP application built in top of MariaDB and LDAP which acts as a central user portal for high-performance-computing clusters. Features include:
+* Automation of LDAP object/user creation with SSH public key configurations
+* Custom user group creation in LDAP
+* Cluster notices
+* Content Management
+* Modularity for external websites
+* Automatic emails to admins/emails
+* Robust branding customization
+* Custom user options
+* Featured admin panel
+* Many more features, and more to come!
+
+## Installation/Deployment
 1. Web server prerequisites
     1. Accessible OpenLDAP server
     1. Accessible MySQL / MariaDB server
@@ -14,24 +25,12 @@
 1. Composer packages
     1. `cd` to this repository
     1. Install packages `composer update`
-1. Setup config file `resources/config.ini` according to site
+1. Setup config file `config/config.ini` according to your site deployment
 1. Point your web server's document root to `webroot` in this repo
 
-### Directory Structure ###
-* `/webroot` - Public root of the website (http document root)
-* `/resources` - Private directory containing php files not necessary to be public.
-
-The unity/webroot directory should be the **only** publicly accessible location (DocumentRoot in htdocs). The resources directory contains many php scripts that are referenced absolutely in the config.
-
-### Server Setup ###
-This website has a public and private interface. The private interface is authenticated using a shibboleth SP. The following files/directories must be behind a shibboleth SP (configured through apache).
-* `/panel`
-* `/admin` for admins only
-
-### Contributing ###
-
-First, fork this repo, then see the readme in `tools/docker-dev/README.md` to see how to set up a dev environment on your local machine from your fork.
-
-Branch names correspond to version numbers. All commits should be merged via PRs to the version branches during development. Once a version is released the branch cannot be updated.
+The scope of this project ends at being responsible for the LDAP user database. We recommend production deployments to set up scripts which detect changes in LDAP and then perform further actions. For example, a script can be used to create Slurm scheduler accounting roles based on the LDAP information created by this website.
 
-Be sure to update `CHANGELOG` with any changes by version.
+## Web Server Setup
+External to this codebase, you must configure authentication using your web server. You must retrict the following:
+* `/panel` - users who are signed in
+* `/admin` - admins who are signed in

Diff for: config/branding/config.ini

@@ -2,6 +2,7 @@
 name = "Unity Cluster"  ; Name of the website
 url = "https://unity.rc.umass.edu/"  ; URL of the website
 description = "The Unity Cluster is a shared High-Performance-Computing cluster maintained by UMass Amherst, University of Rhode Island, and UMass Dartmouth"  ; Description of the website
+logo = "logo.png"
 
 [colors]
 light_background = "#ffffff"  ; Background color when in light mode

Diff for: tools/config_generator.sh

@@ -118,13 +118,3 @@ header>button.hamburger>img {
         margin-left: 250px;
     }
 }
-
-/* Only show MGHPCC overlay image if height and width support it */
-
-@media only screen and (min-width: 1001px) and (min-height: 1000px) {
-    nav.mainNav {
-        background: url("/res/mghpcc-image.png"), var(--accent);
-        background-position: center bottom;
-        background-repeat: no-repeat;
-    }
-}