Demo installation

tutorial

If you are interested in setting up a Mender server for production, visit Production installation

If you are interested in evaluating Mender features, visit Get Started

This tutorial covers how to setup a demonstration environment of the Mender server. This is not intended for production use, the demonstration environment is insecure and is not optimized to run effectively.

This can be useful if you want to familiarize your self with the Mender server before you move on to Production installation.

Requirements

The demo environment requires the following components to be available on your system:

In addition, add the following lines to /etc/hosts:

127.0.0.1 s3.docker.mender.io
127.0.0.1 docker.mender.io

This is needed because demo certificates for the HTTPS communication are created for s3.docker.mender.io and docker.mender.io

Manage the Mender demo instance

Starting the demo

Clone the integration repository which contains everything that is need to start the demo server:

git clone -b 2.7.2 https://github.com/mendersoftware/integration.git integration-2.7.2

Change directory to the cloned repository:

 cd integration-2.7.2

Start the demo server:

./demo up

After a short while, depending on your network connection speed, you should see similar output to the following:

Creating integration_minio_1        ... done
Creating integration_mender-gui_1   ... done
Creating integration_mender-nats_1                   ... done
Creating integration_mender-mongo_1 ... done
Creating integration_mender-workflows-worker_1       ... done
Creating integration_mender-useradm_1                ... done
Creating integration_mender-deviceconfig_1           ... done
Creating integration_mender-inventory_1              ... done
Creating integration_mender-workflows-server_1       ... done
Creating integration_mender-create-artifact-worker_1 ... done
Creating integration_mender-deviceconnect_1          ... done
Creating integration_mender-device-auth_1            ... done
Creating integration_mender-api-gateway_1            ... done
Creating integration_mender-deployments_1            ... done
Creating a new user...
****************************************

Username: mender-demo@example.com
Login password: xxxxxxxxxxxx

****************************************

Please note that Docker Hub enforced limits on pulls originating from anonymous users to 100 per 6 hours (see: Docker pricing). This means that, for reasons completely independent from Mender, the above step may fail and you may have to retry after some time.

The script created a demo user, and you can login to the Mender UI by visiting https://localhost.

You might get a warning from your browser that that the site is not secure. This is because we use self-signed certificates in the demo environment and can be safely ignored.

Stopping the demo

To stop the demo use Ctrl+C. This will only stop the containers, but will not remove them. To remove containers use commands from the section below.

Clean up the environment

You will lose all state data in your Mender demo environment by running the commands below, which includes devices you have authorized, software uploaded, logs, deployment reports and any other changes you have made.

If you want to remove all state in your Mender demo environment and start clean, run the following commands in the integration-2.7.2 directory:

./demo stop
./demo rm -v
./demo up

Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to submit changes.