Skip to content
This repository was archived by the owner on Apr 19, 2021. It is now read-only.

Commit 025afc8

Browse files
Helianthellasvenefftinge
authored andcommitted
[docs] explain that GITPOD_ env vars are reserved
1 parent d58ccf9 commit 025afc8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/docs/environment-variables.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
You can pass environment variables into your workspace.
44

5+
## Default Environment Variables
6+
The following environment variables are set automatically by Gitpod and are guaranteed to exist:
7+
8+
- `GITPOD_WORKSPACE_ID`: The Universally Unique Identifier (UUID) associated with the workspace.
9+
- `GITPOD_WORKSPACE_URL`: The unique URL of the workspace.
10+
11+
### Reserved Prefix
12+
Environment variables beginning with the prefix `GITPOD_` are reserved for internal use by Gitpod and are overridden on every workspace startup. This means that a _user-defined_ variable set with the name `GITPOD_FOOBAR` will be ignored and not accessible in the workspace.
13+
514
## User-Specific Environment Variables
615
Gitpod supports encrypted, user-specific environment variables.
716
They are stored as part of your user settings and can be used to set access tokens, or pass any other kind of user-specific information to your workspaces.

0 commit comments

Comments
 (0)