5.7 KiB
| title |
|---|
| Env Variables |
Environment variables are used to configure projects based on the context in which they run. This allows them to exhibit different behaviors in different environments, such as development, staging, or production.
For instance, during development, you may want your project to connect to a local development database running on your machine, but in production, you may prefer it to connect to the production database. Similarly, in development, you may want to use a test Stripe account, while in production, your app should use a real Stripe account.
While some env vars are required by Wasp, such as the database connection or secrets for social auth, you can also define your env vars for any other useful purposes.
In Wasp, you can use environment variables in both the client and the server code.
Client Env Vars
Client environment variables are embedded into the client code during the build and shipping process, making them public and readable by anyone. Therefore, you should never store secrets in them (such as secret API keys).
To enable Wasp to pick them up, client environment variables must be prefixed with REACT_APP_, for example: REACT_APP_SOME_VAR_NAME=....
You can read them from the client code like this:
console.log(import.meta.env.REACT_APP_SOME_VAR_NAME)
console.log(import.meta.env.REACT_APP_SOME_VAR_NAME)
Check below on how to define them.
Server Env Vars
In server environment variables, you can store secret values (e.g. secret API keys) since are not publicly readable. You can define them without any special prefix, such as SOME_VAR_NAME=....
You can read them in the server code like this:
console.log(process.env.SOME_VAR_NAME)
console.log(process.env.SOME_VAR_NAME)
Check below on how to define them.
Defining Env Vars in Development
During development, there are two ways to provide env vars to your Wasp project:
- Using
.envfiles. (recommended) - Using shell. (useful for overrides)
1. Using .env (dotenv) Files
This is the recommended method for providing env vars to your Wasp project during development.
In the root of your Wasp project you can create two distinct files:
.env.serverfor env vars that will be provided to the server.
Variables are defined in these files in the form of NAME=VALUE, for example:
DATABASE_URL=postgresql://localhost:5432
SOME_VAR_NAME=somevalue
-
.env.clientfor env vars that will be provided to the client.Variables are defined in these files in the form of
NAME=VALUE, for example:REACT_APP_SOME_VAR_NAME=somevalue
These files should not be committed to version control, and they are already ignored by default in the .gitignore file that comes with Wasp.
2. Using Shell
If you set environment variables in the shell where you run your Wasp commands (e.g., wasp start), Wasp will recognize them.
You can set environment variables in the .profile or a similar file, or by defining them at the start of a command:
SOME_VAR_NAME=SOMEVALUE wasp start
This is not specific to Wasp and is simply how environment variables can be set in the shell.
Defining environment variables in this way can be cumbersome even for a single project and even more challenging to manage if you have multiple Wasp projects. Therefore, we do not recommend this as a default method for providing environment variables to Wasp projects. However, it can be useful for occasionally overriding specific environment variables because environment variables set this way take precedence over those defined in .env files.
Defining Env Vars in Production
While in development, we had the option of using .env files which made it easy to define and manage env vars. However, in production, we need to provide env vars differently.
Client Env Vars
Client env vars are embedded into the client code during the build and shipping process, making them public and readable by anyone. Therefore, you should never store secrets in them (such as secret API keys).
You should provide them to the build command, for example:
REACT_APP_SOME_VAR_NAME=somevalue npm run build
:::info How it works
What happens behind the scenes is that Wasp will replace all occurrences of import.meta.env.REACT_APP_SOME_VAR_NAME with the value you provided. This is done during the build process, so the value is embedded into the client code.
Read more about it in Vite's docs. :::
Server Env Vars
The way you provide env vars to your Wasp project in production depends on where you deploy it. For example, if you deploy your project to Fly, you can define them using the flyctl CLI tool:
flyctl secrets set SOME_VAR_NAME=somevalue
You can read a lot more details in the deployment section of the docs. We go into detail on how to define env vars for each deployment option.