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
    Facebook Open Graph META Tags

    It's no secret that Facebook has become a major traffic driver for all types of websites.  Nowadays even large corporations steer consumers toward their Facebook pages instead of the corporate websites directly.  And of course there are Facebook "Like" and "Recommend" widgets on every website.  One...

  • By
    Page Visibility API

    One event that's always been lacking within the document is a signal for when the user is looking at a given tab, or another tab. When does the user switch off our site to look at something else? When do they come back?

Incredible Demos

  • By
    Create a Spinning, Zooming Effect with CSS3

    In case you weren't aware, CSS animations are awesome.  They're smooth, less taxing than JavaScript, and are the future of node animation within browsers.  Dojo's mobile solution, dojox.mobile, uses CSS animations instead of JavaScript to lighten the application's JavaScript footprint.  One of my favorite effects...

  • By
    Flashy FAQs Using MooTools Sliders

    I often qualify a great website by one that pay attention to detail and makes all of the "little things" seem as though much time was spent on them. Let's face it -- FAQs are as boring as they come. That is, until you...

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!