Local development installation

Installing Alumio for development can be done with a few simple steps described below. The process has been set up so that engineers can get started with Alumio without having to worry about their local development set up.

Requirements to run Alumio locally:

Although our software can run on the operating systems listed below, we recommend running Alumio on Linux. On Linux, Alumio performs at its best.

Linux

  1. The (free) Ansible Workstation package installs and configures all required software.
  2. Alternatively, each package can be installed separately.
    1. Docker
    2. Docker Compose
    3. Docker Compose Development Manager

Mac

  1. Install the necessary tools:
    1. Docker
    2. Docker Compose
    3. Docker Compose Development Manager
  2. It is recommended to increase the default amount of memory available to Docker to at least 6 GB.
    1. Open `Docker` by pressing the Command key and typing `Docker`.
    2. In the settings click on the `Advanced` tab.
    3. Increase the amount of memory and click `Apply & Restart`.

Windows

  1. Install the necessary tools:
    1. Docker Desktop
    2. Docker Compose Development Manager
    3. Git Bash
  2. After the Docker Compose Development Manager has been installed `dev` has to be added to the $PATH environment variable.
    1. Press the Windows key and type `Edit the Environment Variables`.
    2. Click `Environment variables`.
    3. Select `Path` under `User Variables` and click `Edit`.
    4. Click `Browse` and select the directory where `Docker Compose Development Manager` is installed.
    5. Close and re-open `Git Bash` if it was running.
  3. It is recommended to increase the default amount of memory available to Docker to at least 6 GB.
    1. Open the `Docker Desktop` settings by right-clicking `Docker Desktop` in the system tray and click `Settings`.
    2. Under `Resources` increase the amount of memory and click `Apply & Restart`.
  4. Use `Git Bash` to execute the next steps instead of `PowerShell` or `CMD`.

 

Access to our composer environment is required to install and run Alumio locally. This access can be facilitated by Alumio.