next-runtime-dotenv
Version:
Expose environment variables to the runtime config of Next.js
97 lines (68 loc) • 2.66 kB
Markdown
# next-runtime-dotenv
> Expose environment variables to the runtime config of Next.js
[](https://www.npmjs.com/package/next-runtime-dotenv)
[](https://codecov.io/gh/tusbar/next-runtime-dotenv)
[](https://github.com/xojs/xo)
## CI
[](https://github.com/tusbar/next-runtime-dotenv/actions/workflows/tests.yml)
[](https://github.com/tusbar/next-runtime-dotenv/actions/workflows/release.yml)
## Getting started
```bash
$ yarn add next-runtime-dotenv
```
This [Next.js](https://github.com/zeit/next.js) plugin uses [dotenv](https://github.com/motdotla/dotenv) to expose environment variables to the Next.js runtime configuration.
It requires `next@5.1.0`.
## Usage
This module exposes a function that allows to configure a Next.js plugin.
In your `next.config.js`:
```js
const nextRuntimeDotenv = require('next-runtime-dotenv')
const withConfig = nextRuntimeDotenv({
// path: '.env',
public: [
'MY_API_URL'
],
server: [
'GITHUB_TOKEN'
]
})
module.exports = withConfig({
// Your Next.js config.
})
```
Then in your page, use the configuration values as such:
```js
import getConfig from 'next/config'
const {
publicRuntimeConfig: {MY_API_URL}, // Available both client and server side
serverRuntimeConfig: {GITHUB_TOKEN} // Only available server side
} = getConfig()
function HomePage() {
// Will display the variable on the server’s console
// Will display undefined into the browser’s console
console.log(GITHUB_TOKEN)
return (
<div>
My API URL is {MY_API_URL}
</div>
)
}
export default HomePage
```
## Serverless deployment
This module is not compatible with serverless deployment as `publicRuntimeConfig` and `serverRuntimeConfig` from `next/config` will not be exposed.
You should use [build-time configuration](https://github.com/zeit/next.js#build-time-configuration).
## Phases
This plugin leverages `next@5.1.0` and build phases. It exposes a plugin function in order to run the plugin only when running the server (`PHASE_DEVELOPMENT_SERVER` and `PHASE_PRODUCTION_SERVER`).
## License
MIT
## Miscellaneous
```
╚⊙ ⊙╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
```