Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

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.


yarn add gatsby-plugin-env-variables


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.

© 2023 Gatsby, Inc.