envkey-webpack-plugin

Use envkey as a webpack plugin.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
envkey-webpack-plugin
35792.1.025 days ago5 years agoMinified + gzip package size for envkey-webpack-plugin in KB

Readme

envkey-webpack-plugin

A webpack plugin that wraps EnvKey's Node.js library so you can easily inject allow-listed configuration into your browser apps.
All vars will be available on process.env in the browser.
To make process.env.NODE_ENV available, just add it to the permitted allow-list (see below).

Install

npm i envkey-webpack-plugin --save-dev

Usage

var webpack = require("webpack"),
  EnvkeyWebpackPlugin = require("envkey-webpack-plugin");

module.exports = {
  //...

  plugins: [
    new EnvkeyWebpackPlugin({
      permitted: ["STRIPE_PUBLISHABLE_KEY", "PUSHER_APP_KEY", "NODE_ENV"], // required, specify allow-list of vars to pull from Envkey -- you can also include "NODE_ENV" to make that available

      dotEnvFile: ".env", // optional, specify alternate dotenv file path like ".env.staging" -- file should include valid ENVKEY variable

      define: { ANOTHER_VAR: "anotherVal" }, // optional, set additional vars on `process.env`
    }),
  ],

  //...
};