Table of contents

• Introduction
• Prerequisites
  • Linux and Mac 
  • Windows 
• Access to the Alumio code
  • Composer repository 
  • Requesting access 
• Setting up a new project 
  • Accessing the project 
• Stopping and restarting the environment 
• How to keep your local Alumio installation up to date 

Introduction

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. 

You will need to become an Alumio solution partner in order to get access to the Software Development Kit (SDK). Reach out to your sales representative to receive more information. 

Prerequisites

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 and Mac 

Install the necessary tools: 

• Docker 
• Docker Compose

Mac 

It is recommended to increase the default amount of memory available to Docker to at least 6 GB. 

• Open `Docker` by pressing the Command key and typing `Docker`. 
• In the settings click on the `Advanced` tab. 
• Increase the amount of memory and click `Apply & Restart`. 

Windows 

Currently not supported. 

Access to the Alumio code

Composer repository 

The Alumio code depends on other packages which are hosted on a composer repository. To be able to install Alumio dependencies access to this repository is needed. These credentials will be provided on request, by Alumio. 

Requesting access 

To get access to the Alumio code send an email to your Alumio contact person and ask for Composer access. Login details will be provided to access the composer repository. 

Setting up a new project 

To set up a new project run the following command: 

bash -c "$(curl -sL sdk.alumio.com/create-project)" -s alumio-sdk

This will create a project in the alumio-sdk directory and install all dependencies that Alumio needs. 

The project is now set up and ready for development. 

Accessing the project 

After setting up the project by default the following services are available: 

• Dashboard: http://localhost/ 
• Kibana: http://localhost:5601 
• API: http://localhost:3200/schema.json 
• MySQL: localhost:3306 
• Elasticsearch: http://localhost:9200 

Credentials for the different services are available in `.env.dev` and can be overwritten with `.env.dev.local`. 

To access the project, go to the dashboard and enter the port of API (default: 3200) as the environment.

Stopping and restarting the environment 

Use the alumio command to stop all docker instances: 

cd alumio-sdk 
alumio down

The environment can be started again by doing: 

cd alumio-sdk 
alumio up

How to keep your local Alumio installation up to date 

Use the composer command to update dependencies: 

cd alumio-sdk 
alumio console 
composer update

Use the alumio command to update docker files 

cd alumio-sdk 
alumio selfupdate 
alumio update