If you're having trouble at any stage please contact us at support@skyformation.com.  

IMPORTANT NOTE

This guide is for SkyFormation version 2.1.21 and above. If you are using an older version of SkyFormation make sure to upgrade SkyFormation first before running the below procedure.

Preface

The API access is disabled by default. To enable it, create an integration user & password for use with Basic Authentication by following the steps below.

Steps

1. SSH to your SkyFormation machine, login as root.
   
   
2. Type the command docker inspect sk4_conf
   If you see an entry with key "device" - the value of it is the location of the conf volume. Otherwise (device may not exist), the value of the key "Mountpoint" is the location of the conf volume.
   

   root@ip-172-31-13-90:~# docker volume inspect sk4_conf

   [

       {

           "CreatedAt": "2019-06-10T15:13:05Z",

           "Driver": "local",

           "Labels": {

               "com.docker.compose.project": "sk4",

               "com.docker.compose.volume": "conf"

           },

           "Mountpoint": "/var/lib/docker/volumes/sk4_conf/_data", --> if "device" does not exist, use                                                                                                                   this as the location.

           "Name": "sk4_conf",

           "Options": {

               "device": "/opt/exabeam/data/sk4/conf", --> If this line exists, use this as the location.

               "o": "bind",

               "type": "none"

           },

           "Scope": "local"

       }

   ]

3. cd into the directory mentioned in the mountpoint value, for example:
   

   root@ip-172-31-38-29:~# cd /var/lib/docker/volumes/sk4_conf/_data
   root@ip-172-31-38-29:/var/lib/docker/volumes/sk4_conf/_data#

    

4. Make a backup copy to the file shiro/client-shiro.ini by typing 
   cp shiro/openapi-shiro.ini shiro/openapi-shiro.ini.orig
   
   
5. Edit the file shiro/client-shiro.ini as described below to add as many read only or admin users as you please. 
   
   

   To add basic authentication read only integration user:

   In the file shiro/openapi-shiro.ini , under [users], add a new line with
   username = password format

            Example:

            [users]
            mynewuser = somepassword

    

   To add basic authentication admin integration user:

   In the file shiro/openapi-shiro.ini , under [users], add a new line with
   username = password,integration-admin format

            Example:

            [users]
            mynewuser = somepassword,integration-admin

   * You can add multiple integration users, both read only and admin users

    

   Example:

            [users]
            bob = bob123
            alice = alice123,integration-admin
    

    Here we've defined two integration users, bob as read only integration user and alice as an integration admin

6. Restart the SkyFormation app by running the command 
   sudo service sk4compose restart

Done