This article is about saving username and password credentials information for secure database access on 3rd party sites such as mLab in your local testing environment. This lets you protect them from anyone looking at your public repository on a site like github.
Secure or private information should never be stored inside your code and pushed to a repository. This is because it would be publicly exposed which puts your information at risk. It also puts you at risk of losing API or database access if someone uses your credentials fraudulently.
This wiki article discusses how to protect your credentials using the export command. In order to make these variables persistent you have two choices. However, the enivorment variables set this way are erased each time the shell is restarted, such as when you shut down your computer and restart for a new coding session.
You’d have to go through all the steps again to set your environment variables each time you started a new terminal shell. This means you’d need to store your credentials in text file somewhere, or keep looking them up in your third party account (such as mLab).
Doing this each time you start a new session gets tedious. So rather than store these in the code itself where it’s easy to find, I’m going to show you a way to use the text file and import your credentials.
The first choice is to use your shell profile and export these variables each time you start up a new terminal. However over a few weeks of developing new applications and projects your shell profile would get clogged up with a massive list of variables that you won’t need every session. You only need the credentials for the application you are currently working on.
Cleaning up a git repo containing secure credentials
If you have already pushed your repository to github with your credentials stored in the codebase, simply deleting them and pushing it again will not help. This is because your credentials are stored in your history, which is visible to the public as well. If this is the case use these commands to reset your git repository and wipe out your history.
First, delete your repo from github. You’ll create a new one when we are ready.
Second, delete your local git repository from your working directory. Change directories to your working directory. Your .git repo file should be in here.
BEWARE: using the -rf flag can delete your entire hard drive if not used correctly. I use the -i flag, which stands for interactive to be certain I am IN the correct directory.
After sorting through a few files and I am 100% sure I’m in the right place, I’ll kill that command and run it again without the -i flag. Do what you feel most comfortable with, but it’s advised that you have a full backup of your computer (in more than one place) before running a -rm command.
cd <project-name> rm -i -rf .git
Third, be sure to update your .gitignore file to include the .env file in addition to any other folders you wish to keep private. Local IDE files such as .idea/ if using jetbrains for example, could be in this file. My .gitignore file looks like this. Note that you can add a folder or file here before it is created without causing any errors.
Finally create a new repository. Now you’re ready to continue creating your .env file and pushing your repo safely to github and keep your credentials safe.
How to use dotenv in your local application
This is where the node module dotenv can help. To use dotenv, you need to require it in your application code. Call the config() function on it which pulls your credentials from a locally stored file on your computer. This file is named
Step 1: Create a .env file and store your variables in it
Step 2: Require dotenv in your main application in your main
app.js (or whatever you have named it)
var dotenv = require('dotenv');
Step 3: Call the config function on your variable. (note this can all be done in one line by chaining, but I like seeing this occur as a separate activity).
Step 4: Set your mongodb URL by calling your process varables:
var url = process.env.MONGOLAB_URI;
This solution keeps your code clean of the secure credentials you do not want to push to a public repository, while keeping each application neatly organized and saving time during development.
At the command line, environmental variables are defined for the current shell and become inherited by any running command or process. They can determine anything from the default shell, the PATH, etc.