The SIEM gateway Docker container (portnox-siem)

In this topic, you will learn what the portnox-siem Docker container does, its requirements, how to deploy it, and how its update behavior works.

Overview

The portnox-siem Docker container lets you forward Portnox Cloud alerts and activity log data to an on-premises SIEM solution, without needing a public IP address or open inbound port on your network. The container works by polling Portnox Cloud for new events over an outbound TLS connection, and then forwarding them to the syslog listener or SIEM collector you specify, on your local network. It is available in the public Docker repository as portnox/portnox-siem. It has no virtual machine equivalent.

Requirements

  • The container can run on Linux, or on Windows or macOS via Docker Desktop. If running in a VM environment, we recommend Linux for the best results, since Windows and macOS would require double virtualization.

  • Follow the firewall rules in How to set up the firewall for Portnox Docker containers to connect to Portnox Cloud. The container may not work correctly if any of those rules are missing. The host running the container must also be able to reach, over your local network, the syslog listener or SIEM collector you are forwarding data to.

Deployment

You don’t have to build the docker run command for portnox-siem manually. Portnox Cloud generates the complete command for you, already filled in with the unique APIUSER, APIKEY, and GWID values for your integration, so you only need to copy and run it.

For step-by-step instructions on creating the SIEM integration and deploying the container for a specific platform, see one of the following topics:

Updates

  • If you use a Docker container running on a local Docker host, it does not update automatically, unless you also use the autoupdate container. The autoupdate container updates all Portnox Docker containers when new versions are available. Updating requires recreating the Docker container, so there may be a short service interruption.

  • If you deploy the Docker container in a cloud environment, you cannot use the autoupdate container, because it requires direct access to the local Docker engine, which these managed cloud services do not expose. You must update containers deployed this way manually by redeploying them with the latest image.