Matt Aitken
de302858f8
* Started building out the docs navigation * Drafted out a lot of the docs pages. With just titles and descriptions with a coming soon message for now. * A ton more scaffolded pages with titles, descriptions, coming soon/incomplete docs messages * Created the remaining page stubs * Introduction page improvements * Lots of docs changes, mostly the task overview page * Moved some bits around * Task overview fleshed out * Triggering docs page * Regular task page * CLi dev docs * Docs for debugging locally * Environment variables docs * Added env var images * Deployment guides * Updated the title of “Integrations” to “Deployment integrations” to make it less confusing * Lots more docs pages * Changed the language to JavaScript * Fixed typos about queues and added a simple code sample * Moved the local debugger docs into the CLI dev page * Added the CLI deploy options * Delete the local debugger page * Updated the logging page with structured logging * Added the new CLI deploy options * Change to h4 for one of the options * Errors page * WIP on retrying * Retrying guide * Wait docs pages * Queuing docs simplified, partial written * Queuing and concurrency docs * Run tests docs * New combined error and retrying page * Errors and retrying page updated * More docs * Added a possible configurations coming soon table * Created a limits page * Added warnings about how you need to get early access * Minor fixes for the docs
66 lines
2.0 KiB
Plaintext
66 lines
2.0 KiB
Plaintext
---
|
|
title: "Environment Variables"
|
|
description: "Any environment variables used in your tasks need to be added so the deployed code will run successfully."
|
|
---
|
|
|
|
An environment variable in Node.js is accessed in your code using `process.env.MY_ENV_VAR`.
|
|
|
|
We deploy your tasks and scale them up and down when they are triggered. So any environment variables you use in your tasks need to accessible to us so your code will run successfully.
|
|
|
|
## Setting environment variables
|
|
|
|
<Steps>
|
|
|
|
<Step title="Go to the Environment Variables page">
|
|
In the sidebar select the "Environment Variables" page, then press the "New environment variable"
|
|
button. 
|
|
</Step>
|
|
|
|
<Step title="Add your environment variables">
|
|
You can add values for your local dev environment, staging and prod. {" "}
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
<Note>
|
|
Specifying Dev values is optional. They will be overriden by values in your .env file when running
|
|
locally.
|
|
</Note>
|
|
|
|
## Editing environment variables
|
|
|
|
You can edit an environment variable's values. You cannot edit the key name, you must delete and create a new one.
|
|
|
|
<Steps>
|
|
|
|
<Step title="Press the action button on a variable">
|
|
|
|
</Step>
|
|
|
|
<Step title="Press edit">
|
|
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Deleting environment variables
|
|
|
|
<Warn>
|
|
Environment variables are fetched and injected before a runs begins. So if you delete one you can
|
|
cause runs to fail that are expecting variables to be set.
|
|
</Warn>
|
|
|
|
<Steps>
|
|
|
|
<Step title="Press the action button on a variable">
|
|
|
|
</Step>
|
|
|
|
<Step title="Press delete">
|
|
This will immediately delete the variable. 
|
|
</Step>
|
|
|
|
</Steps>
|