Server Installation Guide

Atman IoT is provided as a pre-configured docker image that can be downloaded via Docker Hub and installed via docker-compose.

The installation includes:

A pre-confugured MySql database image
The Adminer database management tool
Atman IoT Server
Self-hosted REST API Explorer

Easy to Install#

You can install it by following five (5) simple steps:

Create a new directory and change to it:

$ mkdir /home/$USER/atman-iot && cd /home/$USER/atman-iot

Create a file named docker-compose.yml and edit it with your favorite editor:

$ nano docker-compose.yml

Copy the following into the above file and save it. Please make sure you change MYSQL_ROOT_PASSWORD of docker-compose.yml before the next step. MYSQL_PASSWORD should be left as is, for now:

    version: '3.1'

    services:
      atman-iot:
        image: atmantech/atman-iot
        volumes:
           - ./UPLOADS:/UPLOADS:consistent
           - ./config:/config:consistent
        ports:
          - "2121:2121"
          - "1024-1048:1024-1048"
          - "3000:3000"
        depends_on:
          - atmandb
        links:
          - atmandb
      atmandb:
        image: mysql:5.7.27
        command: --default-authentication-plugin=mysql_native_password
        environment:
          MYSQL_ROOT_PASSWORD: password
          MYSQL_DATABASE: atman_iot
          MYSQL_USER: atman-iot
          MYSQL_PASSWORD: password
        ports:
          - 33060:3306
      adminer:
        image: adminer
        ports:
          - 8080:8080
        depends_on:
          - atmandb

Install with docker-compose:

$ docker-compose up

Chance mysql user password (optional)

Open the database admin page http://localhost:8080/?server=atmandb and login as root, with the MYSQL_ROOT_PASSWORD you used in your docker-compose.yml
Select the atman_iot database, then click on the Privileges tab. Then edit the privileges of user atman-iot
Edit your local configuration file and change the database password:

$ nano /home/$USER/code/atman-iot/config/mysql.datasource.json

tip

The above procedure is applicable for Debian-based Linux OS. Please modify it accordingly if you are using a different operating system!

Starting the server#

You can start the server with docker-compose:

$ cd /home/$USER/atman-iot && docker-compose up

Accessing the server interfaces#

After you start the server, you can access the following interfaces:

Local API documentation: http://localhost:3000/documentation.html
API Explorer: http://localhost:3000/explorer
Database admin page: http://localhost:8080/?server=atmandb

Online API Documentation#

You can find the up to date Atman IoT core API documentation here!