Start on Localhost or Virtual Machine

Goal

This guide will show you how to run MicroPerimeter™ Security on your local or virtual machine using the standalone version.

Software prerequisites

Before you start make sure your system configuration is supported.

Supported operating systems:

  • Linux
  • MacOS

Required software:

  • docker v18.09
  • docker-compose v1.23

For hardware requirments please refer to standalone hardware requirments document

NOTE: If you require a demo of MicroPerimeter™ Security or more information please reach out to our sales team at sales@cloudentity.com

Installation

Prerequisites: Account setup

Navigate to Cloudentity website, click TRY FOR FREE and register. Follow the instructions received via email to register and log in to demo.cloudentity.com

Step 1: Download and unzip the package

After setting up an account, you will be automatically logged in to demo.cloudentity.com

Navigate to Microservices tab and follow the instructions to download the latest version of the MicroPerimeter™ Security installation package.

You will receive the *.zip package with MicroPerimeter™ Security installation scripts.

NOTE: The package comes integrated with Cloudentity™ OAuth/OIDC Authorization Server, but you have an option to integrate with Okta or Azure AD OIDC Authorization Servers. If you are interested in either of these please follow instructions in linked documents below:

Unzip the package.

Step 2: Verify and Prepare the environment

In terminal navigate to unzipped package e.g.:

cd /home/usr/microperimeter

At the very beginning go to the standalone directory:

cd standalone

Verify software prerequisites:

./bin/verify_prerequisites.sh

You should see the following output:

Checking if prerequisites are installed:
docker          18.09   ✔
docker-compose  1.23    ✔

Login to Cloudentity™ docker repository:

echo "HnqXgjVD2ty8QQQIBuaGI6mXoKl7PzCb" | docker login -u microperimeter docker-microperimeter.artifactory.cloudentity.com --password-stdin

Step 3: Deploy & Run MicroPerimeter™ Security

To install MicroPerimeter™ Security run the following command:

CURRENT_UID=$(id -u) docker-compose -f external-services.yaml -f standalone.yaml -p standalone up -d --build

INFO: Running docker-compose for a first takes a few minutes as it’s downloading all images from Cloudentity™ docker repository Upload policies:

Import MicroPerimeter™ Security policies:

./bin/mpctl.sh import -d policies/system/standalone.yaml -d policies/scopes.yaml policies/system/default.yaml

INFO: mpctl.sh the tool allows you to upload MicroPerimeter™ Access Policies.

Run shell script below to show the current progress of services installation. Wait until all MicroPerimeter™ Services are ready.

./bin/wait.sh

The command should succeed with an output:

All services are healthy

Step 4: See the dashboard

Open a browser and navigate to the following page http://localhost:8000/dashboard

After authenticating with preconfigured IDP you should see MicroPerimeter™ dashboard.

Congratulations you just deployed MicroPerimeter™ Security!

Next steps

Now you can choose to: