How to install Omada SDN controller on Linux system(Controller 5.0.29 and above)

Configuration Guide
Updated 03-21-2024 01:08:45 AM 101956
This Article Applies to: 

This article applies to Omada SDN Controller v5.0.29 and above.

For Omada SDN Controller v4, please refer to FAQ 2917.

For Omada Controller v3 and below, please refer to FAQ 2609.

This article will introduce how to install Omada SDN Controller on the Linux platform. | Ubuntu 16.04, 18.04, 20.04, 22.04 | CentOS 6, 7 | Debian 8, 9, 10, 11

1. Back up the configuration

If this is your first Omada Controller installation, you can skip this step.

If you need to upgrade your controller, we strongly recommend that please back up the configuration first.

You can follow the Backup & Restore section of the User Guide to back up your configuration. The following link contains the User Guides for different versions of the Omada Controller: https://www.tp-link.com/support/download/omada-software-controller/

2. Supported Linux distributions

Omada Software Controller on the Linux platform supports the following distributions. It is recommended that you use one of these distributions.

Ubuntu 16.04, 18.04, 20.04, 22.04

CentOS 6, 7

Debian 8, 9, 10, 11

3. Installation on Ubuntu and CentOS systems

We will take Ubuntu 22.04 and CentOS 7 as examples to show the installation process of the Omada SDN Controller.

3.1 Install deb package on Ubuntu 22.04

Omada SDN Controller requires the following dependencies:

  • OpenJDK 8 and above
  • MongoDB v3 or v4
  • JSVC
  • CURL
  • Libssl(Only for Ubuntu 22.04)
  • Chromium(Optional, only essential to PDF Report Export function)

Install OpenJDK

You can use the following command to install Java 8.

sudo apt install –y openjdk-8-jre-headless

You can refer to the following link for the Java official guide: https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html

You can also use the following command to install OpenJDK-11.

sudo apt install –y openjdk-11-jre-headless

Note : if you install OpenJDK-11 or higher, the JSVC version you download should be 1.1.0 or higher. As far as we know, the official Debian or Ubuntu repositories provide JSVC 1.0.5, you may refer to 5.How to compile and install JSVC 1.1.0 or higher.

Install MongoDB

Omada SDN Controller supports MongoDB v3 and v4. Here we will show how to install v4.4.

Install libssl(Only for Ubuntu 22.04)

Libssl is a necessary dependency to download MongoDB on Ubuntu22.04.

If you downloaded Ubuntu version before 22.04, you can skip this step.

Download Libssl dependency.

wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/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/

Install libssl.

sudo dpkg -i libssl1.1_1.1.1-1ubuntu2.1~18.04.23_amd64.deb

Import the public key.

wget -qO - https://www.mongodb.org/static/pgp/server-4.4.asc | sudo apt-key add –

Create /etc/apt/sources.list.d/mongodb-org-4.4.list with the appropriate version of command.

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

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

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

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

Reload the local package database:

sudo apt update

Install MongoDB:

sudo apt install -y mongodb-org

You can also follow the MongoDB official guide below to install different versions.

For MongoDB v4.4: https://docs.mongodb.com/v4.4/tutorial/install-mongodb-on-ubuntu/

For MongoDB v3.4: https://docs.mongodb.com/v3.4/tutorial/install-mongodb-on-ubuntu/

Install jsvc

sudo apt install jsvc

If you have OpenJDK-11 or higher installed, you must install JSVC version 1.1.0 or higher, which might not be provided by some Linux distributions. You may refer to the 5. How to compile and install JSVC 1.1.0 or higher? .

Install curl

sudo apt install curl

Install Omada SDN 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.x_Linux_x64.deb

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.x_Linux_x64.deb

3.2 Install tar.gz package on CentOS 7

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.

Install Java 8

Check for available installers for Java 8.

sudo yum list java-1*

Choose the suitable version for your system and install Java. Here for my x86_64 platform, I use the below command to install Java 8.

sudo yum install –y java-1.8.0-openjdk.x86_64

You can also use the below command to install Java 11.

sudo yum install –y java-11-openjdk.x86_64

Refer to the following link for the Java official guide:

https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html

Install MongoDB

Omada SDN Controller supports MongoDB v3 and v4. Here we will show how to install v4.4.

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.25-1.el7.x86_64.rpm

Use rpm command to install MongoDB.

sudo rpm -ivh mongodb-org-server-4.4.xx-1.elx.xxx.rpm

Install jsvc

sudo yum install –y jsvc

If there is no JSVC installers provided by your yum repositories, please refer to 5.How to compile and install JSVC 1.1.0 or higher?

Install curl

sudo yum install –y curl

Install Omada SDN Controller

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.

tar zxvf Omada_Controller_v5.x.x_Linux_x64.tar.gz

Enter the unzipped folder.

cd Omada_Controller_v5.x.x_Linux_x64

Install the controller.

sudo ./install.sh

4. Run Omada Controller

Here are some commands that can help you check/change the status of the Omada Controller.

  • tpeap status -- show the status of Controller;
  • tpeap start -- start the Omada Controller;
  • tpeap stop --stop running the Omada Controller.

After you start the Omada Controller, you can visit http://localhost:8088 or https://localhost:8043 to access the web management page of the Controller.

5. How to compile and install JSVC 1.1.0 or higher

Confirm you already have these dependencies: autoconf, make, gcc, JDK. If not, you can follow the corresponding steps to install missing dependencies

sudo apt install autoconf make gcc

sudo apt install openjdk-11-jdk-headless

sudo apt remove jsvc (if you have installed through apt or yum before)

Download the source codes from the official website:

wget https://archive.apache.org/dist/commons/daemon/source/commons-daemon-1.2.4-src.tar.gz

tar zxvf commons-daemon-1.2.4-src.tar.gz

cd commons-daemon-1.2.4-src/src/native/unix

Compile and install:

sh support/buildconf.sh

./configure --with-java=/usr/lib/jvm/java-11-openjdk-amd64 (default path of OpenJDK-11-JDK)

make

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/

6. 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.

Download Chromium debian package from Linuxmint:

wget http://packages.linuxmint.com/pool/upstream/c/chromium/chromium_119.0.6045.159~linuxmint1+una_amd64.deb

NoteThe download link will update time to time, you can refer to the following link to choose the latest download link:

http://packages.linuxmint.com/list.php?release=una

Install chromium:

sudo dpkg -i chromium_119.0.6045.159~linuxmint1+una_amd64.deb

Check installation by returning version:

chromium --version

If terminal returns the version of chromium, you can try the following command to run chromium:

chromium

If terminal doesn’t return the version information, then the installation has failed. Please try installing chromium again and rectify the fault according to the error information.

Looking for More

Is this faq useful?

Your feedback helps improve this site.

Recommend Products

From United States?

Get products, events and services for your region.