Skip to main content
View plugin on GitHub
See starters using this

Gatsby Environment Variables Plugin

A Gatsby plugin to whitelist system environment variables to be made available to client-side scripts.

By default, Gatsby only makes system environment variables prefixed with GATSBY_ available to client scripts. Using this plugin, you can make any arbitrary environment variable available at runtime.

Install

yarn add gatsby-plugin-env-variables

or

npm install gatsby-plugin-env-variables

How to use

In gatsby-config.js:

module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-env-variables`,
      options: {
        whitelist: ["MY_VAR", "MY_OTHER_VAR"]
      },
    },
  ],
}

This will make MY_VAR & MY_OTHER_VAR available at runtime in your app by accessing process.env.MY_VAR or process.env.MY_OTHER_VAR.