Environment configuration in Node.js

Introduction

Environment configuration helps your app know important settings like where to find a database or what port to use. It keeps these details separate from your code so you can change them easily.

When you want to run the same app on your computer and on a server but with different settings.

When you need to keep secret keys or passwords safe and not put them directly in your code.

When you want to change the app's behavior without changing the code, like switching between test and live modes.

When you want to share your code but keep your personal settings private.

When you want to easily update settings like API URLs or ports without redeploying the app.

Syntax

Node.js

require('dotenv').config();

const port = process.env.PORT || 3000;
const dbUrl = process.env.DATABASE_URL;

Use a .env file to store environment variables as key=value pairs.

Call require('dotenv').config() at the start of your app to load these variables into process.env.

Examples

This file sets the port and database URL your app will use.

Node.js

# .env file
PORT=4000
DATABASE_URL=mongodb://localhost:27017/mydb

This code loads the environment variables and prints the port number.

Node.js

require('dotenv').config();

console.log(process.env.PORT);

This sets a default port if none is provided in the environment.

Node.js

const port = process.env.PORT || 3000;
console.log(`Server runs on port ${port}`);

Sample Program

This Node.js program loads environment variables from a .env file and prints a greeting with the port number. If the variables are missing, it uses default values.

Node.js

/*
Create a file named .env with:
PORT=5000
GREETING=Hello
*/

import dotenv from 'dotenv';
dotenv.config();

const port = process.env.PORT || 3000;
const greeting = process.env.GREETING || 'Hi';

console.log(`${greeting}, server is running on port ${port}`);

Important Notes

Never commit your .env file to public code repositories to keep secrets safe.

You can use different .env files for development, testing, and production environments.

Environment variables are always strings, so convert them if you need numbers or booleans.

Summary

Environment configuration separates settings from code for flexibility and security.

Use a .env file and the dotenv package to load variables into process.env.

Always provide defaults and keep secrets out of your code.

Practice

1. What is the main purpose of using environment configuration in a Node.js application?

easy

A. To make the application run faster by hardcoding values

B. To write all configuration directly inside the main JavaScript files

C. To separate settings like API keys and ports from the code for flexibility and security

D. To avoid using any external packages or files

Solution

1. Step 1: Understand environment configuration purpose

   Environment configuration helps keep settings like API keys, database URLs, and ports separate from the code.

2. Step 2: Recognize benefits

   This separation allows changing settings without touching code and keeps secrets safe.

3. Final Answer:

   To separate settings like API keys and ports from the code for flexibility and security -> Option C

4. Quick Check:

   Environment configuration = separate settings [OK]

Hint: Think: config outside code for safety and flexibility [OK]

Common Mistakes:

• Hardcoding secrets inside code
• Ignoring security by mixing config and code
• Not using environment variables

2. Which of the following is the correct way to load environment variables from a .env file using the dotenv package in Node.js?

easy

A. require('dotenv').config()

B. import dotenv from 'dotenv'; dotenv.load()

C. require('dotenv').loadEnv()

D. import dotenv from 'dotenv'; dotenv.setup()

Solution

1. Step 1: Recall dotenv usage

   The standard way to load environment variables is calling require('dotenv').config() at the start of your app.

2. Step 2: Check other options

   Options A, B, and D use incorrect method names or syntax not supported by dotenv.

3. Final Answer:

   require('dotenv').config() -> Option A

4. Quick Check:

   dotenv load method = config() [OK]

Hint: Remember: dotenv uses config() to load variables [OK]

Common Mistakes:

• Using wrong method names like load() or setup()
• Mixing import and require incorrectly
• Forgetting to call config()

3. Given the following code snippet and a .env file with PORT=4000, what will be the output?

require('dotenv').config();
console.log(process.env.PORT || 3000);

medium

A. 4000

B. undefined

C. Error: PORT not defined

D. 3000

Solution

1. Step 1: dotenv loads .env variables into process.env

   The call to require('dotenv').config() loads PORT=4000 into process.env.PORT.

2. Step 2: Evaluate console.log expression

   The expression process.env.PORT || 3000 uses the loaded value 4000, so it prints 4000.

3. Final Answer:

   4000 -> Option A

4. Quick Check:

   Loaded PORT = 4000 [OK]

Hint: Loaded env vars override defaults [OK]

Common Mistakes:

• Assuming default 3000 prints even if PORT is set
• Thinking process.env.PORT is undefined
• Expecting an error if .env exists

4. What is the error in this Node.js code that tries to use environment variables?

import dotenv from 'dotenv';
dotenv.config;
console.log(process.env.DB_HOST);

medium

A. dotenv package not imported correctly

B. Missing parentheses after config method call

C. process.env.DB_HOST is undefined by default

D. Cannot use import syntax in Node.js

Solution

1. Step 1: Check dotenv usage

   The code calls dotenv.config without parentheses, so the config function is not executed.

2. Step 2: Effect of missing parentheses

   Without calling config(), environment variables from .env are not loaded, so process.env.DB_HOST may be undefined.

3. Final Answer:

   Missing parentheses after config method call -> Option B

4. Quick Check:

   Call config() with () to load env [OK]

Hint: Always call config() with parentheses [OK]

Common Mistakes:

• Forgetting () after config
• Assuming import syntax always fails
• Ignoring that process.env can be empty

5. You want to safely use an API key in your Node.js app without exposing it in your code. Which approach correctly applies environment configuration best practices?

hard

A. Write the API key in a JSON file and require it in your code

B. Hardcode the API key directly in your main JavaScript file for easy access

C. Push the API key to your public GitHub repository for backup

D. Store the API key in a .env file, load it with dotenv, and access it via process.env.API_KEY

Solution

1. Step 1: Identify secure storage method

   Storing secrets like API keys in a .env file keeps them out of code and version control.

2. Step 2: Use dotenv to load and access keys

   Using dotenv loads the key into process.env, which the app can safely use.

3. Final Answer:

   Store the API key in a .env file, load it with dotenv, and access it via process.env.API_KEY -> Option D

4. Quick Check:

   Secrets in .env, not code [OK]

Hint: Keep secrets in .env, never in code [OK]

Common Mistakes:

• Hardcoding secrets in code files
• Committing secrets to public repos
• Using insecure files for secrets