Portainer Templates logo

Portainer Templates

Omada EAP Controller Omada EAP Controller

Container

ManagementTools

TP-Link Omada is a software-defined network solution. The EAP Controller is used to manage multiple EAPs. Raspberry Pi 1 and Zero are not supported.

Image details

Pulls: 23.2M
Architecture: amd64, arm64, arm/v7
Image size: 471 MB
Latest: 6.0.0.25-openj9
User: mbentley
Created: Oct 07, 2018
Updated: 1 day ago
Status: active

Configuration

Type
Container
Platform
linux
Image
mbentley/omada-controller:latest
Ports
8088:8088/tcp8043:8043/tcp27001:27001/udp27002:27002/tcp29810:29810/udp29811:29811/tcp29812:29812/tcp29813:29813/tcp
Volumes
/config : /portainer/Files/AppData/Config/Omada
Env vars
PUID=1000PGID=1000
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://www.tp-link.com/us/business-networking/omada-sdn-controller/
Official Docker Documentation: https://hub.docker.com/r/mbentley/omada-controller


Standalone Install

Select an install method, to see config/commands for deploying Omada EAP Controller

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Omada EAP Controller, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

mbentley/omada-controller

Docker image for TP-Link Omada Software Controller (also known as TP-Link Omada Network Application) to centrally manage TP-Link Omada Hardware.
!NOTE Disclaimer: I am not, in any way, affiliated with TP-Link. I am just a community member who has packaged TP-Link's free software as a Docker image for easier management and consumption.

Just Getting Started?

Check out the Quickstart Guide for the basics of what you need to know about running the TP-Link Omada Controller in a container and how to operate it successfully.

v5 to v6 Upgrade Guide

The upgrade from v5 to v6 requires a manual step of running an upgrade container for MongoDB. Check out the v5 to v6 Upgrade Guide in the full README for detailed instructions.

Full README

For the full readme which includes a list of tags, including usage examples, upgrade details, known issues, and more, refer to the README in the GitHub repository.

Getting Help & Reporting Issues

If you have issues running the controller, feel free to create a Help discussion and I will help as I can. If you are specifically having a problem that is related to the actual software, I would suggest filing an issue on the TP-Link community forums as I do not have access to source code to debug those issues. If you're not sure where the problem might be, I can help determine if it is a running in Docker issue or a software issue. If you're certain you have found a bug, create a Bug Report Issue.

Serve Omada EAP Controller on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying omada-eap-controller.example.com to http://omada-controller:8088

Add this to your Caddyfile

omada-eap-controller.example.com {
	reverse_proxy http://omada-controller:8088
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs omada-controller
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8088 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8088
  • Stop the other service, or pick a different host port. In 8088:8088 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8088. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, omada-controller can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8088

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/Omada
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull mbentley/omada-controller:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect omada-controller --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Omada EAP Controller runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Omada EAP Controller needs bundled into one download. This template pulls mbentley/omada-controller:latest, which Docker fetches once (about 471 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Omada EAP Controller's comes from Docker Hub, published by mbentley.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 6.0.0.25-openj9. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8088:8088 means it's reachable on port 8088 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8088:8088
  • 8043:8043
  • 27001:27001 over UDP
  • 27002:27002
  • 29810:29810 over UDP
  • 29811:29811
  • 29812:29812
  • 29813:29813

Volumes

A volume is where Omada EAP Controller keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /portainer/Files/AppData/Config/Omada on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Omada EAP Controller takes 2 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000
  • PGID, defaults to 1000

Restart policy

The restart policy here is unless-stopped, so Docker restarts Omada EAP Controller after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Omada EAP Controller sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container omada-controller. That's what you'll spot in the containers list and use in commands like docker logs omada-controller.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Omada EAP Controller up. Add the template list to Portainer once, then deploying Omada EAP Controller is a click rather than a wall of config.