Get and Set Environment Variables in Node.js

By  on  

One of the best ways to use sensitive information in open source repositories without hard-coding the information within publicly available repositories is setting environment variables.  Set the environment variables on the server, retrieve them by key within your application.

When using Node.js, you can retrieve environment variables by key from the process.env object:

var mode = process.env.mode; // 'PRODUCTION', for example

var apiKey = process.env.apiKey; // '38294729347392432'

There are time when you may want to set environment variables while you run your node app -- these are set temporarily while the process is still running.  A common case is simulating environment variables during testing.  You can temporarily set these variables by pegging items onto the process.env object:

process.env.mode = 'TESTING';

// Now app code knows not to do destructive transactions!

Simple enough but worth documenting for future use!

Recent Features

  • By
    Designing for Simplicity

    Before we get started, it's worth me spending a brief moment introducing myself to you. My name is Mark (or @integralist if Twitter happens to be your communication tool of choice) and I currently work for BBC News in London England as a principal engineer/tech...

  • By
    Create a CSS Cube

    CSS cubes really showcase what CSS has become over the years, evolving from simple color and dimension directives to a language capable of creating deep, creative visuals.  Add animation and you've got something really neat.  Unfortunately each CSS cube tutorial I've read is a bit...

Incredible Demos

  • By
    Use Custom Missing Image Graphics Using MooTools

    Missing images on your website can make you or your business look completely amateur. Unfortunately sometimes an image gets deleted or corrupted without your knowledge. You'd agree with me that IE's default "red x" icon looks awful, so why not use your own missing image graphic? The MooTools JavaScript Note that...

  • By
    jQuery topLink Plugin

    Last week I released a snippet of code for MooTools that allowed you to fade in and out a "to the top" link on any page. Here's how to implement that functionality using jQuery. The XHTML A simple link. The CSS A little CSS for position and style. The jQuery...

Discussion

  1. I believe it’s more common to use process.env.NODE_ENV instead of process.env.mode

  2. This is an interesting problem. What if you are using aws or heroku for hosting? You could have your deployment script setup the keys, but you’d need to prompt each time you create a new instance.

    I encrypted the keys in a json file with AES 256 and in my run/deploy script it prompts for a password and decrypts it running the rest of the application with env variables. It’s not perfected yet, but this might be a good way to put it on github.

  3. Caleb

    Are these variables just being set via the command line?

  4. Ola

    I have had great success with json-configurator (https://www.npmjs.com/package/json-configurator). Use it with process.env.NODE_ENV as a input.

    require('json-configurator')(configJson, process.env.NODE_ENV ).userEndpoint;
    
  5. xgqfrms
    # Windows:
    
    SET NODE_ENV=development
    # or
    set NODE_ENV=development
    
    
    # OS X / Linux:
    
    export NODE_ENV=development
    
    
    
    # Windows CMD
    set NODE_ENV=production
    
    
    # Windows PowerShell:
    $env:NODE_ENV="production"
    

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!