Environment variables in Alumio

Table of contents

  • Introduction
  • How to create and view environment variables in Alumio
  • How to convert sensitive data into environment variables
  • Video guide

Introduction

When using Alumio to create a new configuration, convert data or make a new integration, you always work with sensitive data throughout the functionality. Therefore, environment variables are used to encrypt sensitive content to prevent anyone from viewing, copying and using passwords or private keys in your environment.

Navigate System → Environment Variables to follow the topic.

How to create and view environment variables in Alumio

When arriving on the Environment variables page, you see an overview of all variables that have been created in your environment:

  • Name - displays a variable name to use in Alumio in different configurations.
  • Value - indicates sensitive content that may contain private keys, passwords and so on.
  • Encrypted - highlights two senses: true or false which means:
    • True - value will be encrypted with asterisks. When creating a new encrypted value, you can see the details once. However, once it’s created, it can’t be visible to users for copying purposes.
    • False - value doesn’t contain any sensitive information, therefore, it’s visible on the page and throughout configurations when the name of the variable is selected.

To create a new environment variable, use the following steps:

Step 1: Click on the “Create +” button.

Step 2: Input mandatory fields such as Name and Value. If you want to hide the value, activate the Encrypted checkbox.

Step 3: Click on the “Save” button.

Once a new variable is created, you can use it in your configurations for URI, request parameters etc. When ${} is applied in the fields, you are able to view all environment variables so you can select a corresponding one.

How to convert sensitive data into environment variables

Alumio also supports the use of environment variables to manage sensitive data securely. This allows you to convert specific fields, such as API keys or credentials, into environment variables. For instance, when setting up a new HTTP Authentication, you can either use existing environment variables or create new ones directly within the configuration process. Follow this guide to learn how to convert sensitive fields into environment variables effectively.

Step 1: Create a new HTTP Authentication by navigating to Connections → HTTP Authentication → Create a new configuration.

Step 2: Select an appropriate prototype from the list of settings, for example, AWS.

Step 3: Input Access Key. To save the value, click the “…” menu and select the “Convert to Environment Variable” option.

Step 4: A pop-up will expand, allowing you to save the variable. To save, enter the name for better navigation. You can also encrypt the variable or leave it decrypted.

Step 5: Save the environment variable by clicking the “Create” button. If the name of the variable exists, you can change the name and successfully save the variable. For example, the name has been changed from “AWS test variable” to “AWS_Test”.

Note: Once you have created a new variable, the option to create another one on the page will be disabled. To be able to create a new variable, you have to go back and make a new HTTP authentication again.

Step 6: Go to More → System → Environment variables → Select the environment variable you have created and see the details page. If the variable was encrypted, the value won’t be displayed on the details page.

Step 7: To use your new variable, you can create, for example, a Filesystem configuration. Once you create a new configuration, enter ${ allowing a list of variables to expand, suggesting which one you can use.

Step 8: Select the proper variable. You can also hover over the variable to ensure it’s encrypted. Input the other required fields and complete setting up the configuration.

Video guide