> For the complete documentation index, see [llms.txt](https://mojaloop.gitbook.io/mojaloop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mojaloop.gitbook.io/mojaloop/legacy/deployment-guide/local-setup-linux.md).

# Local Setup Linux

Local setup on a Laptop or Desktop to run the Mojaloop project.

## Setup Introduction

This document will provide guidelines to a technical capable resources to setup, deploy and configure the Mojaloop applications on a local environment, utilizing Docker, Kubernetes and HELM charts.

At this point the reader/implementer should be familiar with [Mojaloop's deployment guide](/mojaloop/legacy/deployment-guide.md). Imported information is contained in that document and as such a prerequisite to this document.

* [Mojaloop Setup for Linux (Ubuntu)](/mojaloop/legacy/deployment-guide/local-setup-linux.md#mojaloop-setup-for-linux-ubuntu)
  * [Setup Introduction](/mojaloop/legacy/deployment-guide/local-setup-linux.md#setup-introduction)
  * [1. Environment recommendations](/mojaloop/legacy/deployment-guide/local-setup-linux.md#1-environment-recommendations)
  * [2. Kubernetes](/mojaloop/legacy/deployment-guide/local-setup-linux.md#2-kubernetes)
    * [2.1. MicroK8S](/mojaloop/legacy/deployment-guide/local-setup-linux.md#21-microk8s)
    * [2.2. Docker](/mojaloop/legacy/deployment-guide/local-setup-linux.md#22-docker)
  * [3. Continue with Deployment](/mojaloop/legacy/deployment-guide/local-setup-linux.md#3-continue-with-deployment)

## 1. Environment recommendations

This environment setup was validated on:

* 64-bit version of Ubuntu Bionic 18.04(LTS).
* This guide is based on Ubuntu 18.04.2 (bionic) on a x86\_64 desktop with 8 CPU's and 16GB RAM.

## 2. Kubernetes

Kubernetes installation for a local environment.

### 2.1. MicroK8S

We recommend install directly from the snap store, refer to [microk8s.io/docs](https://microk8s.io/docs) for more information.

Don't have the snap command? [Installing snapd](https://snapcraft.io/docs/installing-snapd).

1. Installing MicroK8s from snap.

   ```bash
   sudo snap install microk8s --classic --channel=1.20/stable
   ```

   *Note: Please check the* [*release notes of your target Mojaloop Helm deployment*](https://github.com/mojaloop/helm/releases) *to see if there are any recommended Kubernetes version prior to installing MicroK8s. The channel parameter specifies the version of Kubernetes to be installed. More information can be found at* [*microk8s.io/docs/setting-snap-channel*](https://microk8s.io/docs/setting-snap-channel)*.*
2. Configure user permission

   ```bash
   sudo usermod -a -G microk8s $USER
   sudo chown -f -R $USER ~/.kube
   ```

   You will also need to re-enter the session for the group update to take place:

   ```bash
   su - $USER
   ```
3. Verify MicroK8s is installed and available.

   ```bash
   microk8s.status
   ```
4. During installation you can use the --wait-ready flag to wait for the kubernetes services to initialize.

   ```bash
   microk8s.status --wait -ready
   ```
5. To avoid colliding with a **kubectl** already installed and to avoid overwriting any existing Kubernetes configuration file, MicroK8s adds a **microk8s.kubectl** command, configured to exclusively access the new **MicroK8s** install.

   ```bash
   microk8s.kubectl get services
   ```
6. This step is only necessary if you require **microk8s.kubectl** to function as a standard **kubectl** command. This **DOES NOT** mean that you can then use **kubectl** to access **OTHER** k8s clusters.

   An example of why you would use this: You have a bash script or 3rd party tool that expects **kubectl** to be available. E.g. If you want to use Helm, it will not work against **microk8s.kubectl**, thus one **MUST** setup the alias for Helm to function correctly.

   ```bash
   snap alias microk8s.kubectl kubectl
   ```

   Reverting it at any time;

   ```bash
   snap unalias kubectl
   ```

   We will stick with the standard command of prefixing with **microk8s.** for this guide.
7. If you already have **kubectl** installed and would like to use it to access the **MicroK8s** deployment.

   ```bash
   microk8s.kubectl config view --raw > $HOME/.kube/config
   ```
8. View the current context.

   ```bash
   microk8s.kubectl config get-contexts
   ```
9. Make sure the current context is **microk8s**. If not, set it as the current context.

   ```bash
   microk8s.kubectl config use-context microk8s
   ```
10. Install an Ingress Controller

    Install an Nginx Ingress Controller for MicroK8s by running the command:

    ```bash
    microk8s enable ingress
    ```

    Alternatively refer to [Deployment Guide - 3.2. Kubernetes Ingress Controller](/mojaloop/legacy/deployment-guide.md#32-kubernetes-ingress-controller) for manual installation.

### 2.2. Docker

Docker is deployed as part of the MicroK8s installation. The docker daemon used by MicroK8s is listening on unix:///var/snap/microk8s/current/docker.sock. You can access it with the **microk8s.docker** command.

1. If you require **microk8s.docker** to function as a standard **docker** command, you set an alias

   ```bash
   sudo snap alias microk8s.docker docker
   ```

   Undo the alias:

   ```bash
   sudo snap unalias docker
   ```
2. Otherwise you can apply the native microK8s commands by prefixing the docker command with `microk8s.`

   ```bash
   microk8s.docker ps
   ```

## 3. Continue with Deployment

1. Continue setup and configuration from the [Mojaloop's deployment guide - 3.2. Kubernetes Admin Interfaces](/mojaloop/legacy/deployment-guide.md#32-kubernetes-admin-interfaces) document.