rsnext/docs/basic-features/environment-variables.md

96 lines
3.8 KiB
Markdown
Raw Normal View History

2020-05-11 08:18:34 +02:00
---
description: Learn to add and access environment variables in your Next.js application.
---
# Environment Variables
> This document is for Next.js versions 9.4 and up. If youre using an older version of Next.js, upgrade or refer to [Environment Variables in next.config.js](/docs/api-reference/next.config.js/environment-variables.md).
2020-05-11 08:18:34 +02:00
<details open>
<summary><b>Examples</b></summary>
<ul>
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/environment-variables">Environment Variables</a></li>
</ul>
</details>
2020-05-11 08:18:34 +02:00
Next.js comes with built-in support for environment variables, which allows you to do the following:
- [Use `.env.local` to load environment variables](#loading-environment-variables)
- [Expose environment variables to the browser](#exposing-environment-variables-to-the-browser)
2020-05-11 08:18:34 +02:00
## Loading Environment Variables
2020-05-11 08:18:34 +02:00
Next.js has built-in support for loading environment variables from `.env.local` into `process.env`.
2020-05-11 08:18:34 +02:00
An example `.env.local`:
```bash
DB_HOST=localhost
DB_USER=myuser
DB_PASS=mypassword
2020-05-11 08:18:34 +02:00
```
This loads `process.env.DB_HOST`, `process.env.DB_USER`, and `process.env.DB_PASS` into the Node.js environment automatically allowing you to use them in [Next.js data fetching methods](/docs/basic-features/data-fetching) and [API routes](/docs/api-routes/introduction).
2020-05-11 08:18:34 +02:00
For example, using [`getStaticProps`](/docs/basic-features/data-fetching#getstaticprops-static-generation):
```js
// pages/index.js
export async function getStaticProps() {
const db = await myDB.connect({
host: process.env.DB_HOST,
username: process.env.DB_USER,
password: process.env.DB_PASS,
})
// ...
2020-05-11 08:18:34 +02:00
}
```
## Exposing Environment Variables to the Browser
2020-05-11 08:18:34 +02:00
By default all environment variables loaded through `.env.local` are only available in the Node.js environment, meaning they won't be exposed to the browser.
2020-05-11 08:18:34 +02:00
In order to expose a variable to the browser you have to prefix the variable with `NEXT_PUBLIC_`. For example:
2020-05-11 08:18:34 +02:00
```bash
NEXT_PUBLIC_ANALYTICS_ID=abcdefghijk
2020-05-11 08:18:34 +02:00
```
This loads `process.env.NEXT_PUBLIC_ANALYTICS_ID` into the Node.js environment automatically. Allowing you to use it anywhere in your code. The value will be inlined into JavaScript sent to the browser because of the `NEXT_PUBLIC_` prefix.
2020-05-11 08:18:34 +02:00
```js
// pages/index.js
import setupAnalyticsService from '../lib/my-analytics-service'
2020-05-11 08:18:34 +02:00
// NEXT_PUBLIC_ANALYTICS_ID can be used here as it's prefixed by NEXT_PUBLIC_
setupAnalyticsService(process.env.NEXT_PUBLIC_ANALYTICS_ID)
2020-05-11 08:18:34 +02:00
function HomePage() {
return <h1>Hello World</h1>
}
2020-05-11 08:18:34 +02:00
export default HomePage
```
2020-05-11 08:18:34 +02:00
## Default Environment Variables
2020-05-11 08:18:34 +02:00
In general only one `.env.local` file is needed. However, sometimes you might want to add some defaults for the `development` (`next dev`) or `production` (`next start`) environment.
2020-05-11 08:18:34 +02:00
Next.js allows you to set defaults in `.env` (all environments), `.env.development` (development environment), and `.env.production` (production environment).
2020-05-11 08:18:34 +02:00
`.env.local` always overrides the defaults set.
2020-05-11 08:18:34 +02:00
> **Note**: `.env`, `.env.development`, and `.env.production` files should be included in your repository as they define defaults. **`.env*.local` should be added to `.gitignore`**, as those files are intended to be ignored. `.env.local` is where secrets can be stored.
2020-05-11 08:18:34 +02:00
## Environment Variables on Vercel
2020-05-11 08:18:34 +02:00
When deploying on [Vercel](https://vercel.com) you can configure secrets in the [Environment Variables](https://vercel.com/docs/v2/build-step#environment-variables) section of the project in the Vercel dashboard.
2020-05-11 08:18:34 +02:00
You can still use `.env`, `.env.development` and `.env.production` to add defaults.
2020-05-11 08:18:34 +02:00
If you've configured [Development Environment Variables](https://vercel.com/docs/v2/build-step#development-environment-variables) you can pull them into a `.env.local` for usage on your local machine using the following command:
2020-05-11 08:18:34 +02:00
```bash
vercel env pull .env.local
2020-05-11 08:18:34 +02:00
```