Variables

In App Platform, you can use variables to store and pass configuration values such as passwords, file paths, tokens, and other environment parameters.

Types of Variables

Copy link

There are two types of variables: local and global.

Local variables:

• Are scoped to a single application
• Are deleted together with the application
• Are configured when creating or editing an application

Global variables:

• Are stored separately from applications
• Can be reused across multiple applications
• Are managed centrally in App Platform → Variables

Local Variables

Copy link

Local variables can be defined when creating an application or by editing the settings of an existing one.

Creating a Local Variable

Copy link

When creating an Application

You can add local variables during application creation.

1. Go to App Platform and start creating an application.
2. In the App settings step, click Add in the Variables section.

3. Enter the variable name and value. To add more variables, click Add More.

4. Enable Save as global if you want this variable to be available to other applications.

You can also upload variables from a file. To do this, click Upload from File and select a .env file. Only files named .env are supported. Variables must be defined in the following format:

APP_NAME=MyApp
APP_ENV=production
DB_HOST=localhost
DB_PORT=3306

In an Existing Application

1. Go to App Platform and select the application.
2. Open the Settings tab and click Edit next to Deploy Settings.

3. In the Variables section, click Add.

4. Enter the variable name and value. To add more variables, click Add More.
5. Enable Save as global if you want this variable to be available to other applications.

Editing a Local Variable

Copy link

1. Go to App Platform and select the application.
2. Open the Settings tab and click Edit next to Deploy Settings.

3. In the Variables section, click the pencil icon next to the variable you want to edit.
4. Make the changes and save.

Deleting a Local Variable

Copy link

1. Go to App Platform and select the application.
2. Open the Settings tab and click Edit next to Deploy Settings.
3. Click the ✕ icon next to the variable you want to delete.

Global Variables

Copy link

Global variables are managed centrally and are available under App Platform → Variables.

Creating a Global Variable

Copy link

1. Go to App Platform → Variables and click Add.
2. Enter the variable name and value. To add more variables, click Add More.
3. You can also upload variables from a file by clicking Upload from file. Only .env files are supported. Variables must be defined in the following format:

APP_NAME=MyApp
APP_ENV=production
DB_HOST=localhost
DB_PORT=3306

Once added, global variables can be selected when creating a new application or editing an existing one. 

Editing a Global Variable

Copy link

1. Go to App Platform → Variables.
2. Click the three-dot menu next to the variable and select Edit.

3. Make the changes and click Save.

Deleting a Global Variable

Copy link

1. Go to App Platform → Variables.
2. Click the three-dot menu next to the variable and select Delete.
3. Confirm the deletion.

If the variable is used by any applications, a list of those applications will be shown. To keep the variable in those applications as a local variable, enable Keep variable as local.