Installation

Docube Installation

Docube Installation on a Linux environment:

Requirements:

Supported Operating System Versions:

The following OS versions are supported:

CentOS 7.x

RHEL 7.x

Pre-conditions:

Make sure that root and internet access is available in the Linux box.

The ports should be open as per architecture.

Download docube-installer.tar.gz from the FTP to /var/tmp/

Keep the master key handy for enabling security features. This key will be used by Docube to keep all sensitive information encrypted. Do not lose this!

Installing Jiffy Client/Jiffy BOT:

Run as a Root User

cd /var/tmp mkdir docube-install-temp mv docube-installer.tar.gz docube-install-temp cd docube-install-temp tar -xvf docube-installer.tar.gz chmod u+x docube_server_nonroot.sh chmod u+x docube_prerequisite_root.sh chown -R docubeapp-usr:docubeapp-usr docube_server_nonroot/ chown -R docubeapp-usr:docubeapp-usr docube_server_nonroot.sh ./docube_prerequisite_root.sh Follow the instructions on the screen.

Switch to docube user

cd /var/tmp/docube-install-temp ./docube_server_nonroot.sh Follow the instructions on the screen.

Start Docube Application

Switch to root /opt/nginx/sbin/nginx
Switch to docube user $DOCUBE_HOME/scripts/start-docube.sh

File Storage /CSV configuration

In an incognito window or another browser navigate to: <Server IP>:8047/storage/dfs

Add the following section with the appropriate data store path as shown in the above image and click on the Update button.



“docubefs”: {

 “location”: “<Data store>/data/docubefs”,

“writable”: true,

“defaultInputFormat”: null

},

Copy the contents of the <Server IP>:8047/storage/dfs file into the clipboard.

In an incognito window or another browser navigate to <Server IP>:8047/storage/dfs1 and paste the copied content.

The CSV configuration section for dfs1 should have the line highlighted in Red below:


 
“csv”:
 
  “type”: “text”,
     
  “extensions”: [
      
 “csv”
         
],
     
“lineDelimiter”: “\r\n”,
    
“delimiter”: “,”
     
}

Run this in the browser: https://<IP address of server>/api/bootstrap

The output should be “Status Done”.

This indicates the end of the installation.

Enabling Security:

Secret Key Generation:

Execute below command to create the master key


            
base_v=echo temp base64
            
echo “base64(”$base_v”)” > $DOCUBE_HOME/.keys/master.key

Steps to create Salt:


            
ssh -p 8101 karaf@localhost

In the karaf console, type the following command


            
docube:salt

Save the generated salt value and press the Ctrl+D keys to exit from the karaf console

Write the copied content to the salt file as shown below


            
echo “BSWvLdLiE4fVjO3o0Pqg3Q==” > $DOCUBE_HOME/.keys/salt.key

Enable Encryption Flag:

Enable encryption as true:

Open command prompt and type the following command. vi $DOCUBE_HOME/apache-karaf-4.0.6/etc/com.option3.docube.cfg
Set the encryption.enabled parameter as true.

Restart karaf:
Open command prompt and type the following command.


                    
$DOCUBE_HOME/apache-karaf-4.0.6/bin/stop
                    
$DOCUBE_HOME/apache-karaf-4.0.6/bin/start
                    
$DOCUBE_HOME/apache-karaf-4.0.6/bin/status

Data Encryption Steps::

Login to the application server
Follow Enable Encryption Flag steps
To login to karaf console, open command prompt and type the following command. ssh -p 8101 karaf@localhost
In the karaf console type the follwoing command: docube:encrypt <data>
The command output is the encrypted value. Use this value instead of plain text.

Enable Drill Password:

Follow Data Encryption Steps here.

Save the generated encryption value for drill use.


            
vi $DOCUBE_HOME/apache-karaf-4.0.6/etc/com.option3.docube.cfg

Add the drill.rest.password with the enc(encrypted password) copied earlier.

Type the following command


            
vi $DOCUBE_HOME/apache-karaf-4.0.6/etc/com.option3.drill-Drill1.cfg

Restart karaf


            
$DOCUBE_HOME/apache-karaf-4.0.6/bin/stop
            
$DOCUBE_HOME/apache-karaf-4.0.6/bin/start
            
$DOCUBE_HOME/apache-karaf-4.0.6/bin/status

Email Configuration

To invite a user, E-mail server details must be configured. There are two ways to setup an email server:

Local SMTP Server

Login to the application server
Open command prompt and type the following command. python -m smtpd -n -c DebuggingServer localhost:1033

E-mail server hosted outside the app server. Eg : Outlook exchange server etc

Login into application server.
Open command prompt and type the following command to add E-mail server details vi $DOCUBE_HOME/apache-karaf-4.0.6/etc/com.option3.docube.cfg
Update the SMTP details in the com.option3.docube.cfg file.
Example: docube.mail.smtp=true docube.mail.hostName=smtp.gmail.com docube.mail.port=587 docube.mail.userName=example@gmail.com docube.mail.password=enc(dfgdfgdf345345cvbnffghfghtfyhf7567=)
Add this configuration if the smtp communication is over SSL. Port is typically 465. docube.mail.enableSslOnConnect=true
Follow steps for Data encryption mentioned here to encrypt the password.
Restart karaf $DOCUBE_HOME/apache-karaf-4.0.6/bin/stop $DOCUBE_HOME/apache-karaf-4.0.6/bin/start

LDAP Configuration

Pre-requisites:

A valid LDAP username password along with connection details. These credentials are used to connect to the LDAP when the karaf commands are executed.

SSL certificate for the LDAP server.

Configuration steps:

Edit [$DOCUBE_HOME/apache-karaf-4.0.6/etc/com.option3.docube.cfg] file and add/update the following fields:


    
docube.ldap.auth.enabled=true
    
docube.ldap.auth.url=ldaps://<ldaphost>:636
    
docube.ldap.auth.userName=<<ldap user>>
    
docube.ldap.auth.password=enc(<<ldap password encrypted in step 1>>)

Follow steps from Data encryption mentioned here to encrypt password.

Configure LDAP search string
Example:


    
docube.ldap.auth.searchBase=DC=ldaptest,DC=option3,DC=io
    
docube.ldap.auth.searchBase=DC=<>,DC=<>,DC=<>

Configure LDAP property under which user name is stored.
Example:


    
docube.ldap.auth.userField=name
    
docube.ldap.auth.userField=<<ldap property storing user name>>

Configure LDAP namespace
Example: docube.ldap.auth.nt4Domain=ldaptest.option3.io


    docube.ldap.auth.nt4Domain=<<domain>>

Certificate Configuration:

To generate and add the SSL certificates to the keystore, open command prompt and execute the following commands. (Skip step 1 if the certificate is already available for the LDAP server)


    echo -n | openssl s_client -connect <ldap hostname>:636 |    sed -ne ‘/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p’ > <<certificate name>>

sudo <<jdk_path>>/bin/keytool -import -trustcacerts -keystore
<<jdk_path>>/jre/lib/security/cacerts -storepass changeit -noprompt -alias <<certificate alias>> -file <<certificate name>

Create Organization:

Go to


            https://<IP Address>/api/organi>

Login to Docube with the serverzation?email=<login email ID>

Enter the default password as password for the user which was created above.

Invite User:

Prerequisites: Email server configuration

Enter the email id to login and click on the Invite button.

If the email server was configured correctly, a link will be sent to the inbox of the respective email id.

If python smtp was used to configure the email, copy the url generated url as shown below, replace with the correct IP and paste into the browser.

Upgrade Steps:

Download files from FTP to DOCUBE server [ $DOCUBE_HOME/uploads/ ]

Stop application


            
$DOCUBE_HOME/scripts/stop-docube.sh

Allow execute permission to docube_upgrade.sh file


            
chmod u+x $DOCUBE_HOME/uploads/docube_upgrade.sh

Execute the docube.sh script


            ./docube_upgrade.sh Both

Start application


            
$DOCUBE_HOME/scripts/start-docube.sh

Troubleshooting Steps

Edit drill memory limits:

If the server RAM is different,

Open the command prompt and type the following command to open the drill configuration file. vi $DOCUBE_HOME/apache-drill-1.16.0/conf/drill-env.sh
Change values of DRILL_HEAP and DRILL_MAX_DIRECT_MEMORY.

Prerequisites & Installation

Installation

Docube Installation

Automation Analytics and AI in a box

HfS Hot Vendor