@thzero/library_server 0.18.16 → 0.18.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -3
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -59,15 +59,16 @@ The following setup for configuration is required for an application using this
59
59
  "auth": {
60
60
  "apiKey": "<generate a GUID as key in standard nomeclature '#######-####-####-####-############'>",
61
61
  "claims": {
62
- "check": false,
63
- "useDefault": false
62
+ "check": <true of false, false by default>,
63
+ "useDefault": <true of false, false by default>
64
64
  }
65
65
  },
66
66
  "cors": {
67
67
  "origin": "*"
68
68
  },
69
69
  "db": {
70
- "atlas": {
70
+ "default": "mongo"
71
+ "mongo": {
71
72
  "connection": "<mongo connection string>",
72
73
  "name": "<environment name>"
73
74
  }
@@ -81,6 +82,24 @@ The following setup for configuration is required for an application using this
81
82
  }
82
83
  ```
83
84
 
85
+ ##### Environment Variable overrides
86
+
87
+ The following environmnent variables override the above configuration settings found in the config file.
88
+
89
+ * AUTH_API_KEY
90
+ * AUTH_CLAIMS_CHECK
91
+ * AUTH_CLAIMS_USE_DEFAULT
92
+ * CORS_ORIGIN
93
+ * DB_DEFAULT
94
+ * DB_CONNECTION_ATLAS
95
+ * DB_NAME_ATLAS
96
+ * DB_CONNECTION_MONGO
97
+ * DB_NAME_MONGO
98
+ * IP_ADDRESS
99
+ * LOGGING_LEVEL
100
+ * LOGGING_PRETTIFY
101
+ * PORT
102
+
84
103
  ##### Development Tool Configuration
85
104
 
86
105
  * Include the following in the package.json for the application.
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@thzero/library_server",
3
3
  "type": "module",
4
- "version": "0.18.16",
4
+ "version": "0.18.17",
5
5
  "version_major": 0,
6
6
  "version_minor": 18,
7
- "version_patch": 16,
8
- "version_date": "06/28/2024",
7
+ "version_patch": 17,
8
+ "version_date": "12/23/2024",
9
9
  "description": "An opinionated library of common functionality to bootstrap an API using either Fastify or Koa as the web server.",
10
10
  "author": "thZero",
11
11
  "license": "MIT",