Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Environment variables [GAIA-3110] #326

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions atlas/additional-guides/environment-variables.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
slug: /atlas/additional-guides/environment-variables
title: Environment Variables
description: Everything about environment variables
---

In this guide, you will learn everything about environment variables in Atlas.

## Default variables

Each of the environments has default environment variables that cannot be deleted:
- `WPE_ATLAS_GIT_PROVIDER`
- `WPE_ATLAS_REPOSITORY`
- `WPE_ATLAS` (always true)
- `WPE_ATLAS_APP_NAME`
- `WPE_ATLAS_ENV_NAME`
- `WPE_ATLAS_COMMIT_SHA`
- `WPE_ATLAS_BRANCH`

These cannot be manually modified, but for example, changing the branch will result in a change of value for `WPE_ATLAS_BRANCH`.

## Custom variables

For each environment separately, you can add, modify, or delete custom environmental variables according to established rules.

The variable cannot be named:
- `HOME`
- `PORT`
- `TMP`
- `TMPDIR`
- `TEMP`

The name of variable cannot start with the prefix:
- `WPE_`
- `K_`
5 changes: 5 additions & 0 deletions atlas/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,11 @@
"label": "Password Protection",
"filePath": "/atlas/additional-guides/password-protection.mdx"
},
{
"type": "doc",
"label": "Environment Variables",
"filePath": "/atlas/additional-guides/environment-variables.mdx"
},
{
"type": "doc",
"label": "Support",
Expand Down