update readme

README.md

-# Beast-Core
+# Beast Core
 
-The Beast Core application is developed by Beast Code to support the
-qualification and maintenance performance and logistical pipelines of military
-personnel, in accordance with DOD's requirements. Beast Core currently
-supports several platforms, including the DDG 1000, DDG 51, Columbia and
-Virginia classes, Bronco II aircraft, and is in the process of being adopted by
-the Navy Enterprise (NAVSEA and NAVAIR).
+The Beast Core application is developed by Beast Code to support the qualification
+and maintenance performance and logistical pipelines of military personnel, in
+accordance with the DOD's requirements. Beast Core currently supports several
+platforms, including the DDG 1000, DDG 51, Columbia and Virginia classes,
+Bronco II aircraft, and is in the process of being adopted by the Navy Enterprise
+(NAVSEA and NAVAIR).
 
 The core functionality of Beast Core is a "digital twin". Each twin is
 comprised of a 3D representation of the platform's systems (e.g., fuel,
 hydraulic, electrical, etc.), linked meta-data and associated technical
 documentation to equipment/components, and a functional model simulating
-equipment behavior that look and act like the real-life platform. The
-application utilizes a digital twin to enhance engineers, operators, and
-maintainers familiarization, qualification, and operation of systems vital to
-the platform's mission. The same model will support the performance of the
-users' proficiency/qualification training and maintenance tasks. In addition,
-the linkage to internal and external metadata makes it a perfect for use as a
+equipment behavior that look and act like the real-life platform. The application
+utilizes a digital twin to enhance engineers, operators, and maintainers
+familiarization, qualification, and operation of systems vital to the platform's
+mission. The same model will support the performance of the users'
+proficiency/qualification training and maintenance tasks. In addition, the
+linkage to internal and external metadata makes it a perfect for use as a
 logistical tool.
 
 Beast Core is web-based technology that can be deployed to an existing server
-infrastructure and run on PCs, laptops and other assets connected to the
-network. The software can also operate on a tablet or mobile device
-(disconnected from the network) allowing users to utilize the digital twin
-anytime, anywhere. Additionally, Beast Core is touchscreen friendly and works
-with a gaming controller to enable an intuitive user interface.
-
-Beast Core licensing and pricing is flexible and supports various
-organizational requirements from a single user up to large scale enterprise
-deployments. Additionally, purchasing a license gives the user access to one
-year of software updates and tech support.
-
-For more information on Beast Core licensing and pricing options please contact
-us at:
+infrastructure and run on PCs, laptops and other assets connected to the network.
+The software can also operate on a tablet or mobile device (disconnected from the
+network) allowing users to utilize the digital twin anytime, anywhere.
+Additionally, Beast Core is touchscreen friendly and works with a gaming
+controller to enable an intuitive user interface.
+
+Beast Core licensing and pricing is flexible and supports various organizational
+requirements from a single user up to large scale enterprise deployments.
+Additionally, purchasing a license gives the user access to one year of software
+updates and tech support.
+
+For more information on Beast Core licensing and pricing options please contact us at:
 Email: info@Beast-Code.com
 Phone: (850) 702-3600
 Website: https://www.beast-code.com/
 
-**Container Requirements**
----
 
-**Software Requirements**: Google Chrome Web Browser
+## Container requirements
+
+**Software requirements**: Google Chrome web browser (client)
+
+**Memory requirements**: The minimum memory requirement is 2GBs RAM. Recommended: 8-16GB RAM
+
+**CPU requirements**:
+- Client: Recommended minimum 2.4GHz Intel Core i5-6300U or equivalent
+- Server: 0.5 core request, 2.0 core limit in kubernetes cluster recommended
+
+**Storage requirements**:
+- Application: none
+- Digital twin: 10-50GB depending on digital twin
+
+**NOTE**: The Beast Core image does NOT come bundled with a digital twin and will not be fully
+functional as a standalone application.
+
+
+## Container configuration
 
-**Memory Requirements**: The minimum memory requirement is 2GBs RAM.
-Recommended: 8-16GB RAM.
+- `PORT`
+    - Port which will serve http traffic (default: `1337`)
+- `WORKSPACE_PATH`
+    - Path where digital twins are mounted (default: `/modules`)
+- `BEASTCODE_BEASTCORE_ENABLEAUTH`
+    - When false or not set, BcoreAuthHandler will automatically approve all requests, thus allowing users to access
+the software without needing to be authorized. When true, BcoreAuthHandler requires authentication.  If false or not set, 
+environment variables below don't need to be set.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_AUDIENCE`
+    - When filled in, tells .Net Core to validate the audience with the provided audience. When
+empty, keeps audience validation turned off.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_ISSUER`
+    - When filled in, tells .Net Core what the JWT issuer should be, but doesn't enforce validation.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_NAMEKEY`
+    - The key in the JWT that should contain the user's name.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_ROLEKEY`
+    - The key in the JWT that should contain the user's role/rank.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_SIGNINGKEY`
+    - The signing key for the JWT. When filled, converts the string into a signing key by
+converting the string into UTF8 bytes, with the only valid algorithm being HmacSha512. It also turns on signing key.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_UIDKEY`
+    - The key in the JWT that should contain the user's UID.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_USERNAMEKEY`
+    - The key in the JWT that should contain the user's username.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_VALIDATEISSUER`
+    -  Validates that all incoming JWTs have the correct issuer set. Needs to be used in
+conjunction with Issuer.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_WORKSPACEKEY`
+    - The JWT claim key to search for when determining what workspaces a user has access to.
+- `BEASTCODE_BEASTCORE_AUTH_JWT_WORKSPACEREGEX`
+    - The regex pattern to pull the valid workspaces from the claim values that match the
+workspace key.
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_TYPE`
+    - The OAuth provider type. Currently the only one natively supported is Keycloak.
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_CLIENTID`
+    - The OAuth workflow ClientId.
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_CLIENTSECRET`
+    - The OAuth workflow ClientSecret.
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_SCOPE`
+    - The OAuth workflow Scope.
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_BASEURL`
+    - The main URL for the provider. Example: https://mainauthprovider.com
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_AUTHENDPOINT`
+    - The main endpoint for the OAuth2 workflow. Should start with a ```/```. ```Example: /oauth2/auth```
+- `BEASTCODE_BEASTCORE_AUTH_PROVIDER_REDEEMENDPOINT`
+    - The main endpoint to redeem the OAuth2 token. Should start with a ```/```. ```Example: /oauth2/redeem```
 
-**CPU Requirements**: Recommended minimum 2.4GHz Intel Core i5-6300U or
-equivalent.
 
-**Disk Requirements**: Application <100MB, Fully-Developed Digital Twin > 20GB
+## Example usage
 
-**Storage volume Requirements**: Beast Core may either be bundled with a
-Digital Twin or can support Digital Twins hosted on volumes.  The configuration
-is dependent upon our customer's environment and use case.
+Example `docker-compose.yml`:
 
-**Other Client Hardware Requirements**: For optimal performance, it is
-suggested that client systems accessing Beast Core have a NVIDIA GeForce GTX
-1060 video card or equivalent.
+```
+beast-core:
+  image: registry.example.com/beast-core
+  environment:
+    PORT: "1337"
+    WORSKPACE_PATH: /modules
+  volumes:
+    - /path/to/digital-twin-1:/modules/digital-twin-1
+    - /path/to/digital-twin-2:/modules/digital-twin-2
+  ports:
+    - "1337:8080"
 
-NOTE: This Beast Core container does NOT come bundled with a Digital Twin and
-will not be fully functional as a standalone application.
+```