How to install Omada SDN controller on Linux system (above Controller 5.0.29)
133150 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.
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
-
CentOS 6, 7
-
Debian 8, 9, 10, 11
3. Installation Examples
Omada SDN Controller requires the following dependencies:
-
OpenJDK 8 and above
-
MongoDB v3 or v4
-
JSVC
-
CURL
We will take Ubuntu 20.04 and CentOS 7 as examples to show the installation process of the Omada SDN Controller.
3.1 Install deb package on Ubuntu 20.04
Install OpenJDK
You can use the following command to install OpenJDK 8. You can also refer to the Java official guide..
sudo apt install openjdk-8-jre-headless
You can also use the following command to install OpenJDK 11. Note that if you install OpenJDK 11 or higher, you need to install JSVC version 1.1.0 and above. As far as we know, the official Debian or Ubuntu repositories provide JSVC 1.0.5, you may refer to How to compile and install JSVC.
sudo apt install openjdk-11-jre-headless
Install MongoDB
Omada SDN Controller supports MongoDB v3 and v4. Here we will show how to install v4.4.
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.
#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 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 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
Reload the local package database then install MongoDB.
sudo apt update
sudo apt install mongodb-org
You can also follow the MongoDB official guide below to install different versions.
For MongoDB v4.4: Install MongoDB v4.4 Community Edition on Ubuntu
For MongoDB v3.4: Install MongoDB v3.4 Community Edition on Ubuntu
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 How to compile and install JSVC.
sudo apt install jsvc
Install curl
sudo apt install curl
Install Omada SDN Controller
Go to TP-Link 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 Java8
Check for available installers for Java 8.
sudo yum list java-1*
Then 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 java-1.8.0-openjdk.x86_64
You can also use the below command to install Java 11.
sudo yum install java-11-openjdk.x86_64
Refer to the Java official guide.
Install MongoDB
Omada SDN Controller supports MongoDB v3 and v4. Here we will show how to install v4.4.
Download the rpm installer, and use rpm command to install MongoDB.
# For x86_64 platform
sudo wget https://repo.mongodb.org/yum/redhat/8/mongodb-org/4.4/x86_64/RPMS/mongodb-org-server-4.4.11-1.el8.x86_64.rpm
# For Aarch64 platform
sudo wget https://repo.mongodb.org/yum/redhat/8/mongodb-org/4.4/aarch64/RPMS/mongodb-org-server-4.4.11-1.el8.aarch64.rpm
# Installation
sudo rpm -ivh mongodb-org-server-4.4.xx-1.elx.xxx.rpm
Install JSVC
sudo yum install jsvc
If there is no JSVC installers provided by your yum repositories, please refer to How to compile and install JSVC.
Install curl
sudo yum install 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, enter the folder and install the controller.
tar zxvf Omada_SDN_Controller_v5.x.x_Linux_x64.tar.gz
cd Omada_SDN_Controller_v5.x.x_Linux_x64
sudo ./install.sh
4. Run Omada Controller
Here are some commands that can help you check/change the status of 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.
# check the running status of the controller
tpeap status
# start the controller
tpeap start
# stop the controller
tpeap stop
5. How to compile and install JSVC?
Install the dependencies first: autoconf, make, gcc, JDK.
sudo apt install autoconf make gcc
sudo apt install openjdk-11-jdk-headless
# Removed JSVC if you have installed through apt or yum
sudo apt remove jsvc
Download the source codes from Apache official website, then compile and install. Note that the following links are for reference only and may be invalid due to version update, you can visit the website to confirm the current version and download link.
wget https://dlcdn.apache.org/commons/daemon/source/commons-daemon-1.3.1-src.tar.gz
cd commons-daemon-1.3.1-src/src/native/unix
sh support/buildconf.sh
# "/usr/lib/jvm/java-11-openjdk-amd64" is the default installation path of OpenJDK-11.
./configure --with-java=/usr/lib/jvm/java-11-openjdk-amd64
make
# Create a soft link from your JSVC path
ln –s /YOUR_ABSOLUTE_PATH/commons-daemon-1.3.1-src/src/native/unix/jsvc /usr/bin/
Is this faq useful?
Your feedback helps improve this site.