Ubuntu - Installing the Oomnitza Connector

This document details how to download and install the Oomnitza Connector on an Ubuntu machine. 

The command-line examples are given with the assumption that the user is using the bash.

The user responsible for the connector deployment must have root privileges to install binary packages.

Part 1: Installing Python 3.6

In LTS Ubuntu 18.04.4 (and above) python3.6.x (or above) comes preinstalled in the system and is available as python3, but there are additional packages that have to be installed.

Note: the command below expects you have the python3.6 installed. In case of the newer versions of base python3 installed, the corresponding dev package has to be installed (python3.7-dev for python3.7 and so on)

Install the following packages from the command line

~$ sudo apt-get install build-essential python3-pip python3.6-dev libdbus-glib-1-dev python3-dbus libsasl2-dev libldap2-dev  

Part 2: Installing the Oomnitza Connector

Now that the necessary prerequisites have been installed, we may download the connector, and install the python packages. Assume we want to deploy the connector in the /opt directory

/# cd /opt
/opt# wget https://github.com/Oomnitza/oomnitza-connector/archive/master.zip
/opt# unzip master.zip && rm master.zip

This will unpack the code to the new directory named oomnitza-connector-master.

Install the connector python dependencies.

/opt# cd /opt/oomnitza-connector-master/
/opt/oomnitza-connector-master# pip3 install "SecretStorage < 3" 
/opt/oomnitza-connector-master# pip3 install -r requirements.txt 

Part 3: Preparing the Configuration File (And Field Mapping)

With the Oomnitza Connector setup with all requirements installed, we may proceed to generate and setup the config.ini file.

NOTE: If you already have a config.ini file, you may skip this section and simply place your existing config.ini in the root directory (in this example, /opt/oomnitza-connector-master)

1/ Generate the config.ini file

/opt/oomnitza-connector-master# python connector.py generate-ini

2/ Set the config.ini values or migrate an existing GUI config.ini

  1. Learn more about setting up the config.ini file here: https://github.com/Oomnitza/oomnitza-connector/blob/master/README.md#connector-configs
  2. Oomnitza and third party system mappings and credentials must be configured. The mappings should be completed via drag-and-drop from the WebUI (System Settings -> Connectors)

Part 4: Running the Oomnitza Connector

  1. Run the connector, confirm it is working:
/opt/oomnitza-connector-master# python3 connector.py upload [connector]

Note: replace [connector] with an enabled connector, e.g. casper, okta, onelogin, ldap, etc.


python3 connector.py upload ldap --ini=/path/to/first.ini
python3 connector.py upload ldap --ini=/path/to/second.ini

Part 5: Scheduling the Connector

This final section details how to schedule the Oomnitza Connector for regular synchronization on a daily basis. For Ubuntu the natural way to do this is to use cron scheduler .

1/ Open the configuration file

/opt/oomnitza-connector-master# crontab -e

2/ Add the following command to run connector each day at 10PM (replace [connector] with an enabled connector, e.g. casper, okta, onelogin, ldap, etc). You may set any other schedule you want, it is just an example, for more examples and schedule syntax description please visit the link https://en.wikipedia.org/wiki/Cron

0 22 * * * cd /opt/oomnitza-connector-master && python3 connector.py upload [connector]

3/ Save configuration and exit

Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk