Skip to main content

​
Environment variables in Mage Pro

Environment variables are set from the Mage Pro cluster management portal. Check out the steps and video below on how to create environment variables.

​
Adding or modifying environment variables:

  • Click the “Edit / add variables” button
  • On the Environment Variables screen, you can either input a value directly or add a custom environment variable by specifying its key-value pair
  • Click “Save changes” to update the settings.
After clicking the “Save changes” button the cluster will automatically restart.

​
Environment variables in Mage OSS

Environment variables may be set in your Docker container to configure Mage settings. If you’re running Mage using pip or conda, your local machine’s environment variables are accessible within the running Mage app. Environment variables are different from runtime variables or secrets. If you’re running Mage using Docker, you must add the following command line flags: 
-e SOME_VARIABLE_NAME_1=secret_value_1 -e SOME_VARIABLE_NAME_2=secret_value_2
The command to run Mage using Docker could look like this: 
docker run -it -p 6789:6789 -v $(pwd):/home/src \
    -e SOME_VARIABLE_NAME_1=secret_value_1 -e SOME_VARIABLE_NAME_2=secret_value_2 \
    mageai/mageai /app/run_app.sh mage start [project_name]

​
Setting the prefix for Mage URL

You may need to add a prefix to the Mage url. You can configure the Mage server to start at a prefix to the url by setting the MAGE_BASE_PATH environment variable. Make sure to set the base path without the leading slash. For example, if you want to start Mage at http://localhost:6789/base/url/path, you would configure your environment variable like this: export MAGE_BASE_PATH=base/url/path You can also configure the base path separately for client requests and backend routes by setting the MAGE_REQUESTS_BASE_PATH and MAGE_ROUTES_BASE_PATH environment variables respectively.
MAGE_BASE_PATHSet base path for the entire app.
MAGE_REQUESTS_BASE_PATHSet base path for frontend requests and urls, defaults to value of MAGE_BASE_PATH
MAGE_ROUTES_BASE_PATHSet base path for backend routes, defaults to value of MAGE_BASE_PATH

​
Default variables

These are the environment variables used in Mage.
Variable nameDescriptionExample values
ACTIVE_DIRECTORY_DIRECTORY_IDSet this value to your organization’s tenant id to enable signing in with Microsoft account.More info
AUTHENTICATION_MODESet the authentication mode in Mage. Omitting the variable will default to basic password authentication.ldap
DATAFRAME_SAMPLE_COUNT_PREVIEWNumber of lines to display in block sample output preview for dataframes. Not suggested to go over 10 lines (defaults to 10).5
DEBUGTurn on “debug” mode. Mage will output more logs that could be useful for debugging issues.1
DEFAULT_EXECUTOR_TYPEThe default executor type to run blocksSee enum types here
K8S_DEFAULT_CONFIG_PATH(Mage Pro only.) Path to YAML file for default K8s executor config; merged with block/project config. Prefer configuring via Helm k8sExecutorConfig. K8s executor · Helm—
K8S_EXECUTOR_DEFAULT_RESOURCE_REQUESTS_CPU(Mage Pro only.) Default CPU request for K8s executor jobs (when not specified in config)250m
K8S_EXECUTOR_DEFAULT_RESOURCE_REQUESTS_MEMORY(Mage Pro only.) Default memory request for K8s executor jobs (when not specified in config)512Mi
K8S_EXECUTOR_DEFAULT_RESOURCE_LIMITS_CPU(Mage Pro only.) Default CPU limit for K8s executor jobs (when not specified in config)500m
K8S_EXECUTOR_DEFAULT_RESOURCE_LIMITS_MEMORY(Mage Pro only.) Default memory limit for K8s executor jobs (when not specified in config)1Gi
K8S_EXECUTOR_DEFAULT_SERVICE_ACCOUNT_NAME(Mage Pro only.) Default service account for K8s executor jobs. See K8s executor docs for more detailsdefault
WORKSPACE_DEFAULT_CONFIG_PATH(Mage Pro only.) Path to YAML file for default workspace config; merged with user config. Prefer configuring via Helm workspaceConfig. Workspaces · Helm—
WORKSPACE_DEFAULT_RESOURCE_REQUESTS_CPU(Mage Pro only.) Default CPU request for workspace containers (when not specified in container_config). See Workspaces docs500m
WORKSPACE_DEFAULT_RESOURCE_REQUESTS_MEMORY(Mage Pro only.) Default memory request for workspace containers (when not specified in container_config)2Gi
WORKSPACE_DEFAULT_RESOURCE_LIMITS_CPU(Mage Pro only.) Default CPU limit for workspace containers (when not specified in container_config)4
WORKSPACE_DEFAULT_RESOURCE_LIMITS_MEMORY(Mage Pro only.) Default memory limit for workspace containers (when not specified in container_config)8Gi
DISABLE_NOTEBOOK_EDIT_ACCESSSetting this variable will disable edit access based on the value. More information1
DISABLE_TERMINALSetting this variable will disable access to the terminal.1
ENVSet the environment of the Mage app. You can use different code or configurations in different environments.dev, staging, production/prod, test
GIT_REPO_LINKMore informationSee link
GIT_REPO_PATHMore informationSee link
GIT_USERNAMEMore informationSee link
GIT_EMAILMore informationSee link
GIT_AUTH_TYPEMore informationSee link
GIT_BRANCHMore informationSee link
GIT_SYNC_ON_PIPELINE_RUNMore informationSee link
GIT_SYNC_ON_STARTMore informationSee link
GIT_SSH_PUBLIC_KEYMore informationSee link
GIT_SSH_PRIVATE_KEYMore informationSee link
GIT_ACCESS_TOKENMore informationSee link
HIDE_ENV_VAR_VALUESFilter out environment variables in notebook output.1
JWT_SECRETModify the json web token secret used for encoding and decoding access tokens. Defaults to materia.your_jwt_secret
JWT_DOWNLOAD_SECRETModify the json web token secret used for encoding and decoding download tokens. Defaults to randomly generated string value. Use an explicit value in horizontally scalable deployments, e.g.: kubernetes, cloud deploymentsyour_jwt_secret
LDAP_ADMIN_USERNAMEMore informationSee link
LDAP_SERVERMore informationSee link
LDAP_BIND_DNMore informationSee link
LDAP_BIND_PASSWORDMore informationSee link
LDAP_BASE_DNMore informationSee link
LDAP_AUTHENTICATION_FILTERMore informationSee link
LDAP_AUTHORIZATION_FILTERMore informationSee link
LDAP_GROUP_FIELDMore informationSee link
LDAP_ROLES_MAPPINGMore informationSee link
LDAP_DEFAULT_ACCESSMore informationSee link
LOGS_DIR_PATHOverride the logs directory path. Default path is the variables_dir path (e.g. /home/src/mage_data/)/home/src/logs_dir
MAGE_ACCESS_TOKEN_EXPIRY_TIMEMore informationSee link
MAGE_BASE_PATHThe base path or prefix of the Mage server url. More informationbase/path
MAGE_REQUESTS_BASE_PATHMore informationbase/path
MAGE_ROUTESBASE_PATHMore informationbase/path
MAGE_CACHE_DIRECTORYThe directory Mage uses for storing and retrieving temporary data used in the UI./root/.mage_data/default_repo/.cache
MAGE_DATABASE_CONNECTION_URLSpecify the database connection url for orchestration DB. Defaults to local sqlite db.Example
MAGE_PUBLIC_HOSTThe public host url that can be used to access the Mage app. This value will be used in emails or other notifications.http://localhost:6789
MAX_PRINT_OUTPUT_LINESThe max number of stdout lines, such as from print statements, included in a message from the websocket server. Defaults to 1000.100
REQUIRE_USER_AUTHENTICATIONEnable user authentication in Mage. More information1
RUN_PIPELINE_IN_ONE_PROCESSWhen True, pipelines will run in one process, unless otherwise specified in the settings for a given pipeline.1
SERVER_VERBOSITYMore informationSee link
SHELL_COMMANDSet shell command to use for the Mage terminal. Default command is bash for macOS/Unix and cmd for Windows.bash, cmd, …
ULIMIT_NO_FILEOverride the maximum number of open files allowed in Mage processes.8192
USER_CODE_PATHSet this path to be /home/src/{your_project_name} so that Mage starts your project and installs the packages in requirements.txt when starting the container./home/src/mage_project