Environment Variables

Overview

Environment variables in Webiny are optional for most scenarios. When needed, they follow a prefix-based system that ensures variables are only available to the appropriate application. This prevents accidental exposure of sensitive data between applications.

Application Prefixes

Webiny uses prefixes to route variables to specific applications:

• WEBINY_ADMIN_ - Variables for the Admin application
• WEBINY_API_ - Variables for the API application

Usage

Setting Variables

Create a .env file in your project root:

Accessing Variables

In your extensions, access variables through process.env:

TypeScript Support

Add type definitions for your environment variables:

Best Practices

Security

1. Never commit .env - Add to .gitignore
2. Use prefixes - Isolate sensitive data by application
3. Rotate secrets - Change production secrets regularly
4. Minimal exposure - Only set variables that are needed

Documentation

Create .env.example for team reference:

Variable Naming

Follow consistent naming conventions: