Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen
Info

Manual installation is suitable for multi-server distributed deployment, or when expanding your current deployment. If you are not sure how to proceed with it, use the automated installers instead.

Before you begin

Please read the following important notes before you begin installing BellaDati IoT Data Collector:

  • Check that your target machine meets (at least) the minimal system requirements (appropriate HW and SW, including Java).
  • Your BellaDati instance is up and running, and it is accessible from your target machine.

Steps 

Below are the steps in short:

  1. Get IoT Data Collector JAR distribution archive
  2. Start Audit module and get the server-ID
  3. Obtain valid license key
  4. Configure Audit module
  5. Configure other modules (Receivers and Senders)
  6. Start Audit and other modules

In the next chapters, each step is described in detail.

1. Get IoT Data Collector

Manual installation is based on running particular modules as Java programs, thus you need the IoT Data Collector JAR distribution. You can visit BellaDati Download Page for information about the current version and fordownloading instructions.

Image Modified

Once you have downloaded the the JAR distribution archive, you can unzip it's content, which should contain (see Files and directories to get more details about the content):

  • iot-collector-audit-x.y.z.jar
  • iot-collector-generic-receiver-x.y.z.jar
  • iot-collector-generic-sender-x.y.z.jar
  • config-audit.json
  • config-receiver.json
  • config-sender.json
  • cluster.xml

2. Obtain server-ID

Audit module is distributed as iot-collector-audit-x.y.z.jar file. You can start it by executing the following command:

Code Block
languagebash
java -Dapplication.name=audit-1 -Dfile.encoding=UTF8 -jar iot-collector-audit-x.y.z.jar

This command will start the audit with the default configuration of the cluster and audit. If necessary, it is also possible to manually specify these files:

Code Block
languagebash
java -Dapplication.name=audit-1 -Dvertx.hazelcast.config=cluster.xml -Dfile.encoding=UTF8 -jar iot-collector-audit-x.y.z.jar -conf config-audit.json

When you start the Audit module for the first time, it automatically creates file server-id.txt in your installation directory.

3. Obtain license key

Once you have the server-ID, you can request the license key from BellaDati support, either by creating request in our Help desk, or by contacting our support at support@belladati.com.

4. Configure Audit module

Each module configuration is container in appropriate conf.json file. Default filename for Audit module configuration is confg-audit.json, however the name can be changed and then just reflected when starting the module.

The default configuration is sufficient, unless you are deploying HA or multi-server IoT Data Collector instance. The only field you need to change is "license" (there are two "license" field, update both).

Code Block
languagejs
{
  "instance": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",
    ...
  },
  "audit": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",
    ...
  }
}

For complete configuration example, click below.

Code Block
linenumberstrue
collapsetrue
{
  "instance": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",                  
    "name": "Awesome Company - TEST_ENV",                            
    "db": {                                                          
      "url": "jdbc:hsqldb:file:/path/to/instance-db;shutdown=true",  
      "user": "SA",                                                  
      "password": "",                                                
      "driverclass": "org.hsqldb.jdbcDriver",                        
      "max_pool_size": 100,                                           
      "drop": false                                                   
    },
    "auth": {                                                         
      "enabled": true,                                                
      "drop": false,                                                  
      "merge": true,                                                  
      "users": [                                                      
        {
          "username": "admin",                                        
          "password": "DAAF8173380C604B392A1EF8D7559AA0",             
          "salt": "BA1170DE9ADE8D29D2C18FD789EAB3BD",                 
          "roles": [ "ADMIN" ]                                        
        }
      ]
    }
  },
  "audit": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",                   
    "name": "Audit 01",                                               
    "host": "localhost",                                              
    "port": 8000,                                                     
    "bodyLimit": 2097152,                                             
    "db": {                                                           
      "url": "jdbc:hsqldb:file:/path/to/my-audit-db;shutdown=true",   
      "user": "SA",                                                   
      "password": "",                                                 
      "driverclass": "org.hsqldb.jdbcDriver",                         
      "max_pool_size": 100,                                           
      "jsonVarcharLength": 2047,                                      
      "drop": false                                                   
    },
    "auth": {
      "enabled": true,                                                
      "drop": false,                                                  
      "merge": true,                                                  
      "users": [                                                      
        {
          "username": "viewer",                                       
          "password": "DAAF8173380C604B392A1EF8D7559AA0",             
          "salt": "BA1170DE9ADE8D29D2C18FD789EAB3BD",                 
          "roles": [ "VIEWER" ]                                       
        }
      ]
    },
    "ssl": {
      "enabled": true,                                                
      "keystorePath": "/path/to/server-keystore.jks",                 
      "keystorePassword": "wibble"                                    
    }
  }
}
Tip

See Audit configuration to get more information.

5. Configure other modules

See Configuring collector.

6. Start collector modules

When all configuration is set, you can proceed to starting all modules. The first module to be started is always Audit.

 

 

Sv translation
languageja
Info

Manual installation is suitable for multi-server distributed deployment, or when expanding your current deployment. If you are not sure how to proceed with it, use the automated installers instead.

Before you begin

Please read the following important notes before you begin installing BellaDati IoT Data Collector:

  • Check that your target machine meets (at least) the minimal system requirements (appropriate HW and SW, including Java).
  • Your BellaDati instance is up and running, and it is accessible from your target machine.

Steps 

Below are the steps in short:

  1. Get IoT Data Collector JAR distribution archive
  2. Start Audit module and get the server-ID
  3. Obtain valid license key
  4. Configure Audit module
  5. Configure other modules (Receivers and Senders)
  6. Start Audit and other modules

In the next chapters, each step is described in detail.

1. Get IoT Data Collector

Manual installation is based on running particular modules as Java programs, thus you need the IoT Data Collector JAR distribution. You can visit BellaDati Download Page for information about the current version and fordownloading instructions.

Image Added

Once you have downloaded the the JAR distribution archive, you can unzip it's content, which should contain (see Files and directories to get more details about the content):

  • iot-collector-audit-x.y.z.jar
  • iot-collector-generic-receiver-x.y.z.jar
  • iot-collector-generic-sender-x.y.z.jar
  • config-audit.json
  • config-receiver.json
  • config-sender.json
  • cluster.xml

2. Obtain server-ID

Audit module is distributed as iot-collector-audit-x.y.z.jar file. You can start it by executing the following command:

Code Block
languagebash
java -Dapplication.name=audit-1 -Dfile.encoding=UTF8 -jar iot-collector-audit-x.y.z.jar

This command will start the audit with the default configuration of the cluster and audit. If necessary, it is also possible to manually specify these files:

Code Block
languagebash
java -Dapplication.name=audit-1 -Dvertx.hazelcast.config=cluster.xml -Dfile.encoding=UTF8 -jar iot-collector-audit-x.y.z.jar -conf config-audit.json

When you start the Audit module for the first time, it automatically creates file server-id.txt in your installation directory.

3. Obtain license key

Once you have the server-ID, you can request the license key from BellaDati support, either by creating request in our Help desk, or by contacting our support at support@belladati.com.

4. Configure Audit module

Each module configuration is container in appropriate conf.json file. Default filename for Audit module configuration is confg-audit.json, however the name can be changed and then just reflected when starting the module.

The default configuration is sufficient, unless you are deploying HA or multi-server IoT Data Collector instance. The only field you need to change is "license" (there are two "license" field, update both).

Code Block
languagejs
{
  "instance": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",
    ...
  },
  "audit": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",
    ...
  }
}

For complete configuration example, click below.

Code Block
linenumberstrue
collapsetrue
{
  "instance": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",                  
    "name": "Awesome Company - TEST_ENV",                            
    "db": {                                                          
      "url": "jdbc:hsqldb:file:/path/to/instance-db;shutdown=true",  
      "user": "SA",                                                  
      "password": "",                                                
      "driverclass": "org.hsqldb.jdbcDriver",                        
      "max_pool_size": 100,                                           
      "drop": false                                                   
    },
    "auth": {                                                         
      "enabled": true,                                                
      "drop": false,                                                  
      "merge": true,                                                  
      "users": [                                                      
        {
          "username": "admin",                                        
          "password": "DAAF8173380C604B392A1EF8D7559AA0",             
          "salt": "BA1170DE9ADE8D29D2C18FD789EAB3BD",                 
          "roles": [ "ADMIN" ]                                        
        }
      ]
    }
  },
  "audit": {
    "license": "n5NkzaEOALzvGs7LOExyAulYdqo8X+5==",                   
    "name": "Audit 01",                                               
    "host": "localhost",                                              
    "port": 8000,                                                     
    "bodyLimit": 2097152,                                             
    "db": {                                                           
      "url": "jdbc:hsqldb:file:/path/to/my-audit-db;shutdown=true",   
      "user": "SA",                                                   
      "password": "",                                                 
      "driverclass": "org.hsqldb.jdbcDriver",                         
      "max_pool_size": 100,                                           
      "jsonVarcharLength": 2047,                                      
      "drop": false                                                   
    },
    "auth": {
      "enabled": true,                                                
      "drop": false,                                                  
      "merge": true,                                                  
      "users": [                                                      
        {
          "username": "viewer",                                       
          "password": "DAAF8173380C604B392A1EF8D7559AA0",             
          "salt": "BA1170DE9ADE8D29D2C18FD789EAB3BD",                 
          "roles": [ "VIEWER" ]                                       
        }
      ]
    },
    "ssl": {
      "enabled": true,                                                
      "keystorePath": "/path/to/server-keystore.jks",                 
      "keystorePassword": "wibble"                                    
    }
  }
}


Tip

See Audit configuration to get more information.

5. Configure other modules

See Configuring collector.

6. Start collector modules

When all configuration is set, you can proceed to starting all modules. The first module to be started is always Audit.