Install and Start the SmartSupervisor

SmartSupervisor is available with SmartServer 4.4 and higher.

To install and start SmartSupervisor, perform the following steps:

1. Set up a SmartSupervisor host computer.
   
   

2. Purchase and then download the SmartSupervisor Docker image to the SmartSupervisor host. See SmartServer Release Notes for the SmartSupervisor download link.

   1. Contact our Sales team at edge.info@enocean.com for more information about the SmartSupervisor license models that are available for purchase.

       

3. Create a new directory for the SmartSupervisor Docker image using the following commands:

   cd ~ mkdir docker cd docker

    

4. Create a docker group using the following command:

   sudo groupadd docker

    

5. Add your username to the docker group using the following command:

   sudo usermod -aG docker $USER

    

6. Log out of your session completely, and then log back in, in order for your group membership changes to take effect.
   
   

7. Load the SmartSupervisor Docker image into Docker system using the following command:

    

8. Create a postgres Docker volume using the following command:

    

9. Expose ports 80, 443, and 8883 as needed using the following commands:

   Example

    

10. Verify that the path /home/echelon/backups exists on the SmartSupervisor host system before running the Docker container. 
    
    

11. If you are not using PKI certificate management, then run the Docker container using the following command:

    Run the Docker container

    The following parameter can be used to specify a custom web page for a user homepage:

    Specify a custom web page for a user homepage

     

12. If you are using PKI certificate management, then run the Docker container using the following command:

    Manage PKI certificates

    The following variables are configurable for your environment:

    • ROOT_CA specifies the full path of the file that is passed to the container and that is needed by the certificate manager in order to establish a trusted connection with the certificate authority (e.g., /etc/ssl/certs/ca/ca_root.pem).

      • PKI_DIR_URL is the API URL to which the certificate manager will connect in order to obtain the certificates.

      • SSIOT_SUFIX_DOMAIN specifies the domain used by the SmartServers. It is added to the SmartServers' SID to get the fully qualified domain name (FQDN) for the requested certificate. For example, if the domain is example.com and you want to access SmartServers by domain names using the format <SID>.example.com, then you should set SSIOT_SUFFIX_DOMAIN to .example.com (include the leading period).

      • /var/apollo/data is mounted as a persistent volume, which also stores status data for all certificates that are generated by certificate manager.
        
        

13. Start SmartSupervisor using the following command:

     

To continue setting up SmartSupervisor by enabling SmartSupervisor on each of the SmartServers in the system, go to Enable SmartSupervisor for Each SmartServer.

To update the SmartSupervisor, see Updating the SmartSupervisor.