		{
		"name": "shared-node-env",
		"version": "1.0.2",
		"description": "A Node.js library designed to handle the creation of shared Environment Variables within multiple node applications running on the same server. It can also be used to manage Environment Variables for single applications as well.",
		"version": "1.0.3",
		"description": "A Node.js library designed to handle the creation of shared Environment Variables within multiple node applications running on the same server and sharing identical environmental variables that must be updated across all applications when changed.",
		"main": "index.js",
		@@ -6,0 +6,0 @@ "scripts": {

+46

-9

README.md

		# SharedNodeEnv
		A Node.js library designed to handle the creation of shared Environment Variables within multiple node applications running on the same server
		and sharing identical environmental variables that must be updated across all applications when changed.
		A Node.js library designed to handle the creation of shared Environment Variables within multiple node applications
		running on the same server and sharing identical environmental variables that must be updated across all applications
		when changed.

		@@ -14,2 +15,34 @@ The library also allows for a application specific local environments variable file to be created that holds

		## Use
		Once installed, configured, and the environment files have been created the library is extremely easy to use.
		Any environment variable defined in the shared or local .env files will be available as a property on the 'process.env'
		object within your Node.js application.

		var path = require('path');
		require('SharedNodeEnv')({
		sharedEnv: path.resolve(process.cwd(), '.env-shared'),
		localEnv: path.resolve(process.cwd(), '.env-local'),
		local: false
		});
		console.log('---------');
		console.log('Local Env');
		console.log('---------');
		console.log(process.env.SERVER_ID);

		var express = require('express');
		var favicon = require('serve-favicon');
		var logger = require('morgan');
		var cookieParser = require('cookie-parser');
		var bodyParser = require('body-parser');

		##### IMPORTANT:
		Make sure that the library is loaded, configured, and executed prior to anything else running in your Node.js application.
		This is to make sure that the global environment variables from your shared and local .env files are loaded into
		the 'process.env' object before they are used.

		Above is an example extracted from an Express.js web application. As you can see the library is loaded at the top of
		the server.js file prior to the loading of the Express.js application or any other libraries that might depend on your
		environment variables (PORT for example, for the web server).


		## Configuration
		@@ -32,7 +65,8 @@ The library can accept an optional configuration object that defines two optional configuration values.
		##### localEnv
		Specifies the absolute path to the local environment variables file. This file is meant to be application specific and should only be loaded by a single application. This value ONLY needs to be passed in if the local file is not located in the
		Specifies the absolute path to the local environment variables file. This file is meant to be application specific and
		should only be loaded by a single application. This value ONLY needs to be passed in if the local file is not located in the
		default location at the root of the Node.js application. No matter where the file is located it must be named .env-local.

		##### local
		Because the library assumes the existence of a local environments file the ability to turn off local is premitted through
		Because the library assumes the existence of a local environments file, the ability to turn off local is permitted through
		this configuration value. This is extremely useful when a shared environments file exists but a local does not for a
		@@ -46,5 +80,5 @@ specific application. When set to false the library will not process a local environments file even if one exists.
		## Environment File Format (.env-shared, .env-local)
		The individual environment files are simply comprised of a single array of key/value objects representing each environment variable
		you wish to have added to the process.env object or your application. This of course allows you to add as many variables as needed
		to the file.
		The individual environment files are simply comprised of a single array of key/value objects, in JSON format,
		representing each environment variable you wish to have added to the process.env object of your application.
		This of course allows you to add as many variables as needed to the file.

		@@ -70,3 +104,5 @@ [

		If a confuguration file is provided the library will check for each of the optional config keys and process each one in order starting with the shared env file and then the local. It is for this reason the local will overwrite values provided by the shared env file.
		If a configuration file is provided the library will check for each of the optional config keys and process each one in
		order starting with the shared env file and then the local. It is for this reason the local will overwrite values
		provided by the shared env file.

		@@ -76,3 +112,4 @@ If local is disabled only the shared environment file will be processed.
		## Potential Errors
		If neither a local file nor a shared file is found the library will throw an error. This is due to the fact that the library is being executed within your Node.js application and expects to perform the task it was created for.
		If neither a local file nor a shared file is found the library will throw an error. This is due to the fact that the
		library is being executed within your Node.js application and expects to perform the task it was created for.

		@@ -79,0 +116,0 @@ If either the shared or the local environments file being passed is not named correctly an error will be thrown.

shared-node-env - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics