From 41ada7fa7dd9b7932a515ac9c01d769dfec09e02 Mon Sep 17 00:00:00 2001
From: Csaky <Tim.Csaky@gov.bc.ca>
Date: Wed, 26 Apr 2023 16:29:22 -0700
Subject: [PATCH] README updates

---
 README.md     | 7 +++++--
 app/README.md | 4 ++++
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f851b6c2..7877a2bb 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ To learn more about the **Common Services** available visit the [Common Services
 ```txt
 .github/                   - PR, Issue templates and CI/CD
 app/                       - Application Root
+├── config/                - configuration exposed as environment variables
 ├── src/                   - Node.js web application
 │   ├── components/        - Components Layer
 │   ├── controllers/       - Controller Layer
@@ -28,10 +29,13 @@ app/                       - Application Root
 │   ├── middleware/        - Middleware Layer
 │   ├── routes/            - API Route Layer
 │   └── services/          - Services Layer
+│   └── validators/        - data validation schemas
 └── tests/                 - Node.js web application tests
-chart/                     - General Helm Charts
+charts/                    - General Helm Charts
 └── coms/                  - COMS Helm Chart Repository
     └── templates/         - COMS Helm Chart Template manifests
+k6/                        - sample load testing scripts
+bcgovpubcode.yml           - BCGov public code asset tracking
 CODE-OF-CONDUCT.md         - Code of Conduct
 COMPLIANCE.yaml            - BCGov PIA/STRA compliance status
 CONTRIBUTING.md            - Contributing Guidelines
@@ -44,7 +48,6 @@ SECURITY.md                - Security Policy and Reporting
 
 * [Application Readme](app/README.md)
 * [API Specification](app/README.md#openapi-specification)
-* [Openshift Readme](openshift/README.md)
 * [Product Roadmap](https://github.com/bcgov/common-object-management-service/wiki/Product-Roadmap)
 * [Product Wiki](https://github.com/bcgov/common-object-management-service/wiki)
 * [Security Reporting](SECURITY.md)
diff --git a/app/README.md b/app/README.md
index 3a57b85b..c569a109 100644
--- a/app/README.md
+++ b/app/README.md
@@ -60,6 +60,8 @@ The following variables enable and configure the use of a backend database to su
 | `username` | `DB_USERNAME` | app | Database account username |
 | `password` | `DB_PASSWORD` | | Database account password |
 | `port` | `DB_PORT` | 5432 | Database connection port |
+| `poolMin` | `DB_POOL_MIN` | 2 | avalable connections |
+| `poolMax` | `DB_POOL_MAX` | 10 | available connections |
 
 ### Keycloak Variables
 
@@ -97,7 +99,9 @@ The following variables alter the general Express application behavior. For most
 | `bodyLimit` | `SERVER_BODYLIMIT` | 30mb | Maximum body size accepted for parsing to JSON body |
 | `logFile` | `SERVER_LOGFILE` | | Writes logs to the following file only if defined |
 | `logLevel` | `SERVER_LOGLEVEL` | http | The logging level of COMS |
+| `passphrase` | `SERVER_PASSPHRASE` | | A key to encrypt/decrypt bucket secretAccessKey's saved to the database |
 | `port` | `SERVER_PORT` | 3000 | The port that COMS application will bind to |
+| `privacyMask` | `SERVER_PRIVACY_MASK` | | Strict content privacy controls |
 
 ## Quick Start