diff --git a/docs/02-app/01-building-your-application/07-configuring/03-environment-variables.mdx b/docs/02-app/01-building-your-application/07-configuring/03-environment-variables.mdx index b36edd1b0a..7876459c39 100644 --- a/docs/02-app/01-building-your-application/07-configuring/03-environment-variables.mdx +++ b/docs/02-app/01-building-your-application/07-configuring/03-environment-variables.mdx @@ -14,14 +14,14 @@ description: Learn to add and access environment variables in your Next.js appli 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) +- [Use `.env` to load environment variables](#loading-environment-variables) - [Bundle environment variables for the browser by prefixing with `NEXT_PUBLIC_`](#bundling-environment-variables-for-the-browser) ## Loading Environment Variables -Next.js has built-in support for loading environment variables from `.env.local` into `process.env`. +Next.js has built-in support for loading environment variables from `.env*` files into `process.env`. -```txt filename=".env.local" +```txt filename=".env" DB_HOST=localhost DB_USER=myuser DB_PASS=mypassword @@ -51,7 +51,7 @@ export async function getStaticProps() { > **Note**: Next.js also supports multiline variables inside of your `.env*` files: > > ```bash -> # .env.local +> # .env > > # you can write with line breaks > PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- @@ -211,13 +211,11 @@ export default function Component() { ## Default Environment Variables -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. +Typically, only `.env*` file is needed. However, sometimes you might want to add some defaults for the `development` (`next dev`) or `production` (`next start`) environment. Next.js allows you to set defaults in `.env` (all environments), `.env.development` (development environment), and `.env.production` (production environment). -`.env.local` always overrides the defaults set. - -> **Good to know**: `.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. +> **Good to know**: `.env`, `.env.development`, and `.env.production` files should be included in your repository as they define defaults. All `.env` files are excluded in `.gitignore` by default, allowing you to opt-into committing these values to your repository. ## Environment Variables on Vercel @@ -228,7 +226,7 @@ All types of Environment Variables should be configured there. Even Environment If you've configured [Development Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables#development-environment-variables?utm_source=next-site&utm_medium=docs&utm_campaign=next-website) you can pull them into a `.env.local` for usage on your local machine using the following command: ```bash filename="Terminal" -vercel env pull .env.local +vercel env pull ``` > **Good to know**: When deploying your Next.js application to [Vercel](https://vercel.com), your environment variables in `.env*` files will not be made available to Edge Runtime, unless their name are prefixed with `NEXT_PUBLIC_`. We strongly recommend managing your environment variables in [Project Settings](https://vercel.com/docs/projects/environment-variables?utm_medium=docs&utm_source=next-site&utm_campaign=next-website) instead, from where all environment variables are available. diff --git a/packages/create-next-app/templates/app-tw/js/gitignore b/packages/create-next-app/templates/app-tw/js/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/app-tw/js/gitignore +++ b/packages/create-next-app/templates/app-tw/js/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/app-tw/ts/gitignore b/packages/create-next-app/templates/app-tw/ts/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/app-tw/ts/gitignore +++ b/packages/create-next-app/templates/app-tw/ts/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/app/js/gitignore b/packages/create-next-app/templates/app/js/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/app/js/gitignore +++ b/packages/create-next-app/templates/app/js/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/app/ts/gitignore b/packages/create-next-app/templates/app/ts/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/app/ts/gitignore +++ b/packages/create-next-app/templates/app/ts/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/default-tw/js/gitignore b/packages/create-next-app/templates/default-tw/js/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/default-tw/js/gitignore +++ b/packages/create-next-app/templates/default-tw/js/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/default-tw/ts/gitignore b/packages/create-next-app/templates/default-tw/ts/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/default-tw/ts/gitignore +++ b/packages/create-next-app/templates/default-tw/ts/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/default/js/gitignore b/packages/create-next-app/templates/default/js/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/default/js/gitignore +++ b/packages/create-next-app/templates/default/js/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel diff --git a/packages/create-next-app/templates/default/ts/gitignore b/packages/create-next-app/templates/default/ts/gitignore index fd3dbb571a..f886745c52 100644 --- a/packages/create-next-app/templates/default/ts/gitignore +++ b/packages/create-next-app/templates/default/ts/gitignore @@ -25,8 +25,8 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# local env files -.env*.local +# env files (can opt-in for commiting if needed) +.env* # vercel .vercel