How to install Omada Software Controller on Linux system
135804 Contents
This article introduces how to install Omada Software Controller on the Linux platform.
- Omada SDN Controller installation package
- Ubuntu 16.04, 18.04, 20.04, 22.04
- CentOS 6, 7
- Debian 8, 9, 10, 11
Omada Software Controller supports installation on Windows and Linux systems depending on your need. Here we mainly introduce the installation method in Linux. We will take Ubuntu 22.04 and CentOS 7 as examples to show the installation process of the Omada SDN Controller (the installation method in Debian is same as that in Ubuntu).
We will take Ubuntu 22.04 and CentOS 7 as examples to show the installation process of the Omada SDN Controller (the installation method in Debian is same as that in Ubuntu). You can choose the matching process to follow according to your needs.
You need to install OpenJDK, MongoDB, JSVC and other dependencies before installing your Omada Software Controller. Here we use Ubuntu 22.04 as a sample to help you install these dependencies on Linux.
Run command line window
For Ubuntu / Debian: Click Ctrl + Alt + T on your keyboard to wake up Command Line Window. Then you can input the commands in the following installation guides to install your Omada Software Controller.
Install OpenJDK
Omada Software Controller for Linux support Java-64bit version 8 and above. Here we help you install the OpenJDK 8 and OpenJDK 11 on your system. You can choose the version to install according to your needs.
- For OpenJDK 8, here we help you install the OpenJDK 8 and the JSVC for OpenJDK8 for you.
Step 1. Install OpenJDK-8 with the command.
sudo apt install –y openjdk-8-jre-headless
Step 2. Install JSVC for OpenJDK 8 with the command.
sudo apt install jsvc
- For OpenJDK 11, here we help you install the OpenJDK 11 and the JSVC for OpenJDK11 for you.
Step 1. Install OpenJDK-11 with the command.
sudo apt install –y openjdk-11-jre-headless
Step 2. Install dependencies for JSVC.
sudo apt install autoconf make gcc
Step 3. Download the source codes from the official website(Here we use JSVC 1.2.4 as a sample).
wget https://archive.apache.org/dist/commons/daemon/source/commons-daemon-1.2.4-src.tar.gz
tar zxvf commons-daemon-x.y.z-src.tar.gz
cd commons-daemon-x.y.z-src/src/native/unix
Step 4. Compile and install
sh support/buildconf.sh./configure --with-java=/usr/lib/jvm/java-11-openjdk-amd64 (default path of OpenJDK-11-JDK)
make
Step 5. Create a soft link from your JSVC path:
ln –s /YOUR_ABSOLUTE_PATH/commons-daemon-1.2.4-src/src/native/unix/jsvc /usr/bin/
Note：You can refer to the following link to choose the latest download link of JSVC(1.1.0 and above):
https://archive.apache.org/dist/commons/daemon/source/
Install MongoDB
Prior to version 5.14.20, the Omada Software Controller supported MongoDB versions 3 and 4. With version 5.14.20 and above, the Omada Software Controller now supports MongoDB up to version 7. Here we take MongoDB v4.4 and v7 as examples to help you install MongoDB on your system. You can choose the matching one according to your needs.
- For MongoDB v4.4. Here we help you install the MongoDB v4.4 on your system.
Step 1. Download Libssl dependency.
Libssl is a necessary dependency to download MongoDB on Ubuntu22.04.If you downloaded Ubuntu version before 22.04, you can skip Step 1 & 2.
wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1-1ubuntu2.1~18.04.23_amd64.deb
Step 2. Install libssl.
sudo dpkg -i libssl1.1_1.1.1-1ubuntu2.1~18.04.23_amd64.deb
Note: The download link will update time to time, you can refer to the following link to choose the latest download link：http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/
Step 3. Import the public key.
wget -qO - https://www.mongodb.org/static/pgp/server-4.4.asc | sudo apt-key add –
Step 4. Create /etc/apt/sources.list.d/mongodb-org-4.4.list with the appropriate version of command.
- For Ubuntu 16.04
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
- For Ubuntu 18.04
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
- For Ubuntu 20.04
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
- For Ubuntu 22.04
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
Step 5. Reload the local package database
sudo ap update
Step 6. Install MongoDB
sudo apt install -y mongodb-org
Note: You can also follow the MongoDB official guide below to install MongoDB：https://www.mongodb.com/docs/v4.4/tutorial/install-mongodb-on-ubuntu/
https://www.mongodb.com/docs/v3.4/tutorial/install-mongodb-on-ubuntu/
- For MongoDB v7, here we help you install the MongoDB v7 on your system.
Step 1. Import the public key used by the package management system. From a terminal, install gnupg and curl if they are not already available:
sudo apt-get install gnupg curl
Step 2. Import the MongoDB public GPG key
curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \
sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \
--dearmor
Step 3. Create the list file /etc/apt/sources.list.d/mongodb-org-7.0.list for your version of Ubuntu:
echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list
Step 4. Reload local package database:
sudo apt-get update
Step 5. Install the MongoDB v7.0.7 packages:
sudo apt-get install -y mongodb-org=7.0.7 mongodb-org-database=7.0.7 mongodb-org-server=7.0.7 mongodb-mongosh=7.0.7 mongodb-org-mongos=7.0.7 mongodb-org-tools=7.0.7
Note: You can also follow the MongoDB official guide below to install MongoDB v7：
https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/
Install Omada Software Controller
Go to the official website, download the installation package of Omada SDN Controller, and install it with the following command.
sudo dpkg –i Omada_SDN_Controller_v5.x.y.z_Linux_x64.deb
Note: If you use OpenJDK-11 or higher, JSVC 1.1.0 or higher, please install it with the following command.
sudo dpkg --ignore-depends=jsvc –i Omada_SDN_Controller_v5.x.y.z_Linux_x64.deb
CentOS doesn’t support the deb installation package. Please download the tar.gz package for installation. We still need to install the dependencies including Java, MongoDB, JSVC, and CURL.
Run command line window
Click the right mouse button to bring up a pop-up menu, and you can click the Open Terminal to bring up the Command Line Window. Then you can input the commands in the following installation guides to install your Omada Software Controller.
Install OpenJDK
Omada Software Controller for Linux support Java-64bit version 8 and above. Here we help you install the OpenJDK 8 and OpenJDK 11 on your system. You can choose the version to install according to your needs.
- For Java 8, here we help you install the OpenJDK 8 and the JSVC for OpenJDK 8 for you.
Step 1. Check for available installers for OpenJDK 8.
sudo yum list java-1*
Step 2. Choose the suitable version for your system and install OpenJDK. Here for x86_64 platform, we use the below command to install OpenJDK 8.
sudo yum install –y java-1.8.0-openjdk.x86_64
Step 3. Install the JSVC for OpenJDK 8 on your system.
sudo yum install –y jsvc
- For Java 11, here we help you install the OpenJDK 11 and the JSVC for OpenJDK 11 for you.
Step 1. Check for available installers for OpenJDK 8.
sudo yum list java-1*
Step 2. Choose the suitable version for your system and install OpenJDK. Here for x86_64 platform, we use the below command to install OpenJDK 11.
sudo yum install –y java-11-openjdk.x86_64
Step 3. Install dependencies for JSVC.
sudo apt install autoconf make gcc
Step 4. Download the source codes from the official website(Here we use JSVC 1.2.4 as a sample).
wget https://archive.apache.org/dist/commons/daemon/source/commons-daemon-1.2.4-src.tar.gz
tar zxvf commons-daemon-x.y.z-src.tar.gz
cd commons-daemon-x.y.z-src/src/native/unix
Step 5. Compile and install
sh support/buildconf.sh./configure --with-java=/usr/lib/jvm/java-11-openjdk-amd64 (default path of OpenJDK-11-JDK)
make
Step 6. Create a soft link from your JSVC path:
ln –s /YOUR_ABSOLUTE_PATH/commons-daemon-1.2.4-src/src/native/unix/jsvc /usr/bin/
Note：You can refer to the following link to choose the latest download link of JSVC(1.1.0 and above):
https://archive.apache.org/dist/commons/daemon/source/
Install MongoDB
Prior to version 5.14.20, the Omada Software Controller supported MongoDB versions 3 and 4. With version 5.14.20 and above, the Omada Software Controller now supports MongoDB up to version 7. Here we take MongoDB v4.4 and v7 as examples to help you install MongoDB on your system. You can choose the matching one according to your needs.
- For MongoDB v4.4. Here we help you install the MongoDB v4.4 on your system.
Step 1. Download the rpm installer for MongoDB.
sudo wget https://repo.mongodb.org/yum/redhat/7/mongodb-org/4.4/x86_64/RPMS/mongodb-org-4.4.29-1.el7.x86_64.rpm
Note: The download link will update time to time, you can refer to the following link to choose the latest download link of mongodb-org：
https://repo.mongodb.org/yum/redhat/7/mongodb-org/4.4/x86_64/RPMS/
Step 2. Use rpm command to install MongoDB.
sudo rpm -ivh mongodb-org-server-4.4.xx-1.elx.xxx.rpm
Note: You can also use the below command to install Java 11.
sudo yum install –y java-11-openjdk.x86_64
- For MongoDB v7. Here we help you install the MongoDB v7 on your system.
Step 1. Create a /etc/yum.repos.d/mongodb-org-7.0.repo file so that you can install MongoDB directly using yum and input the follwing repository information:
[mongodb-org-7.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/7/mongodb-org/7.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/server-7.0.asc
Step 2. Install the MongoDB v7.0.7 packages.
sudo yum install -y mongodb-org-7.0.7 mongodb-org-database-7.0.7 mongodb-org-server-7.0.7 mongodb-mongosh-7.0.7 mongodb-org-mongos-7.0.7 mongodb-org-tools-7.0.7
Step 3. Check the installation result.
yum list | grep mongodb
Note: You can also follow the MongoDB official guide below to install MongoDB v7: https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-red-hat/
Install Omada SDN Controller
Step 1. Go to the official website, download the installation package of the Omada SDN Controller. Run the Terminal, change the directory to the folder where you save the installation package. Unzip the installation package.
sudo yum install –y curl
tar zxvf Omada_Controller_v5.x.y.z_Linux_x64.tar.gz
Step 2. Enter the unzipped folder.
cd Omada_Controller_v5.x.y.z_Linux_x64
Step 3. Install the controller.
sudo ./install.sh
Install Chromium Browser (Optional)
Chromium Browser is an optional dependency required by Controller. If you don’t have to export Report in PDF format, you can skip these steps.
Step 1. Download Chromium debian package from Linuxmint.
wget http://packages.linuxmint.com/pool/upstream/c/chromium/chromium_x.y.z~linuxmint1+xxx_amd64.deb
Note: You can refer to the following link to choose the download link of Chromium version related to your System version:
https://www.linuxmint.com/download_all.php
And the source packages pool:
http://packages.linuxmint.com/pool/upstream/c/chromium/
Step 2. Install chromium
sudo dpkg -i chromium_x.y.z~linuxmint1+xxx_amd64.deb
Step 3. Check installation by returning version
chromium –version
Here are 3 commands that can help you check/change the status of the Omada Software Controller.
Step 1. Start the Omada Controller
tpeap start
Step 2. Show the status of Controller
tpeap status
Step 3. Stop running the Omada Controller
tpeap stop
Now you have successfully installed the Omada SDN Controller on your Linux platform.
Get to know more details of each function and configuration please go to Download Center to download the manual of your product.
Is this faq useful?
Your feedback helps improve this site.
TP-Link Community
Still need help? Search for answers, ask questions, and get help from TP-Link experts and other users around the world.