Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
TimCsaky committed Apr 26, 2023
1 parent 5eec390 commit 41ada7f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 41ada7f

Please sign in to comment.