---
schema_version: "1"
id: a99dc44f0e6cfb1fe60e75c53522d3f536e5355010936c11168a5436645d6ee2
title: Downloading Omni Gateway
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/latest/install.md
canonical_url: https://docs.mulesoft.com/gateway/latest/install
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 85c4c393a9469fe6c7416047687e3fdfa6685e64c3dfcaaf646c02b3c08b7f4e
description: MuleSoft Documentation Site
release: "1.14"
latest: true
---
---
product: Omni Gateway
version: 1.14
is-latest-version: true
---

# Downloading Omni Gateway

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Download and install Omni Gateway as a Linux service, or download the Omni Gateway image from the
container registry. Downloading is a prerequisite to registering and running a gateway as a Linux
service or in a container, Kubernetes cluster, or OpenShift cluster.

To run Omni Gateway inside a virtual machine (VM), download and install it as a Linux service. To
run Omni Gateway in a container, Kubernetes cluster, or OpenShift cluster, download the Omni Gateway
image.

<table><colgroup><col> <col> <col> <col></colgroup><tbody><tr><td><div><div><p><span><a href="#linux"><img src="https://docs.mulesoft.com/gateway/latest/_images/install-linux-logo.png" alt="20%" width="20%"></a></span></p></div></div></td><td><div><div><p><span><a href="#container"><img src="https://docs.mulesoft.com/gateway/latest/_images/install-container-logo.png" alt="25%" width="25%"></a></span></p></div></div></td><td><div><div><p><span><a href="#kubernetes"><img src="https://docs.mulesoft.com/gateway/latest/_images/install-kubernetes-logo.png" alt="20%" width="20%"></a></span></p></div></div></td><td><div><div><p><span><a href="#openshift"><img src="https://docs.mulesoft.com/gateway/latest/_images/install-openshift-logo.png" alt="20%" width="20%"></a></span></p></div></div></td></tr><tr><td><div><div><p><a href="#linux">Linux</a></p></div></div></td><td><div><div><p><a href="#container">Container</a></p></div></div></td><td><div><div><p><a href="#kubernetes">Kubernetes</a></p></div></div></td><td><div><div><p><a href="#openshift">OpenShift</a></p></div></div></td></tr></tbody></table>

See [Requirements and Limits for Omni Gateway](https://docs.mulesoft.com/gateway/latest/review-prerequisites) for details about hardware and
software requirements.

## Download and Install as a Linux Service

You can download and install Omni Gateway as a service in one of the following Linux environments:

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-ubuntu-logo.png) Ubuntu

Download and install Omni Gateway as an Ubuntu service

##### Software Requirements

Omni Gateway runs on the following Long Term Support (LTS) versions of Ubuntu:

- Ubuntu Jammy

##### Before You Begin

Before getting started, ensure that you have installed the following:

- [gnupg2](https://gnupg.org/)

- [lsb\_release](https://refspecs.linuxfoundation.org/LSB_3.0.0/LSB-PDA/LSB-PDA/lsbrelease.html)

##### Run Installation Commands

To download and install Omni Gateway as a Ubuntu service, run the command block that performs the
following actions:

- Retrieves the public package keys and adds the package repository

- Updates the package list

- Updates `apt-get`

- Installs the Omni Gateway package

```ssh
curl -XGET https://flex-packages.anypoint.mulesoft.com/ubuntu/pubkey.gpg | sudo apt-key add -
echo "deb [arch=amd64] https://flex-packages.anypoint.mulesoft.com/ubuntu $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/mulesoft.list
sudo apt update
sudo apt install -y flex-gateway
```

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run). For more detail, see
[Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-debian-logo.png) Debian

Download and install Omni Gateway as a Debian service

##### Software Requirements

Omni Gateway runs on the following Long Term Support (LTS) versions of Debian:

- Debian Bookworm

##### Before You Begin

Before getting started, ensure that you have installed the following:

- [gnupg2](https://gnupg.org/)

- [lsb\_release](https://refspecs.linuxfoundation.org/LSB_3.0.0/LSB-PDA/LSB-PDA/lsbrelease.html)

##### Run Installation Commands

To download and install Omni Gateway as a Debian service, run the command block that performs the
following actions:

- Retrieves the public package keys and adds the package repository

- Updates the package list

- Updates `apt-get`

- Installs the Omni Gateway package

```ssh
curl -XGET https://flex-packages.anypoint.mulesoft.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb [arch=amd64] https://flex-packages.anypoint.mulesoft.com/debian $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/mulesoft.list
sudo apt update
sudo apt install -y flex-gateway
```

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run). For more detail, see
[Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-amazon-linux-logo.png) Amazon Linux

Download and install Omni Gateway as an Amazon Linux service

##### Software Requirements

Omni Gateway runs on the following Long Term Support (LTS) version of Amazon Linux:

- Amazon Linux 2023

##### Before You Begin

Before getting started, ensure that you have installed the following:

- [gnupg2](https://gnupg.org/)

##### Run Installation Commands

To download and install Omni Gateway as an Amazon Linux service, run the command block that performs
the following actions:

- Adds the Omni Gateway package repository with a reference to its public key

- Installs the Omni Gateway package

```ssh
sudo tee /etc/yum.repos.d/flex-gateway.repo <<\EOF
[flex-gateway]
name = Anypoint Flex Gateway
baseurl = https://flex-packages.anypoint.mulesoft.com/amazonlinux/2023/main
gpgcheck=1
gpgkey=https://flex-packages.anypoint.mulesoft.com/amazonlinux/pubkey.gpg
repo_gpgcheck=1
enabled=1
EOF

sudo yum install -y flex-gateway
```

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run). For more detail, see
[Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-rhel-logo.png) Red Hat Enterprise Linux

Download and install Omni Gateway as a Red Hat Enterprise Linux service

##### Software Requirements

Omni Gateway runs on the following Long Term Support (LTS) versions of RHEL:

- Red Hat Enterprise Linux (9)

##### Before You Begin

Before getting started, ensure that you have installed the following:

- [gnupg2](https://gnupg.org/)

##### Run Installation Commands

To download and install Omni Gateway as a Red Hat Enterprise Linux service, run the command block
that performs the following actions:

- Adds the Omni Gateway package repository with a reference to its public key

- Installs the Omni Gateway package

```ssh
sudo tee /etc/yum.repos.d/flex-gateway.repo <<\EOF
[flex-gateway]
name = Anypoint Flex Gateway
baseurl = https://flex-packages.anypoint.mulesoft.com/rhel/$releasever/main
gpgcheck=1
gpgkey=https://flex-packages.anypoint.mulesoft.com/rhel/pubkey.gpg
repo_gpgcheck=1
enabled=1
EOF

sudo yum install -y flex-gateway
```

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run). For more detail, see
[Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

#### ![6%](/mulesoft/current/en-us/gateway/latest/_images/install-rhel-ibm-logo.png) Red Hat Enterprise Linux on IBM Power

Download and install Omni Gateway as a Red Hat Enterprise Linux service on IBM Power

##### Software Requirements

Omni Gateway runs on the following Long Term Support (LTS) versions:

- Red Hat Enterprise Linux (9) on IBM Power (ppc64le)

##### Before You Begin

Before getting started, ensure that you have installed the following:

- [gnupg2](https://gnupg.org/)

##### Run Installation Commands

To download and install Omni Gateway as a Red Hat Enterprise Linux service, run the command block
that performs the following actions:

- Adds the Omni Gateway package repository with a reference to its public key

- Installs the Omni Gateway package

```ssh
sudo tee /etc/yum.repos.d/flex-gateway.repo <<\EOF
[flex-gateway]
name = Anypoint Flex Gateway
baseurl = https://flex-packages.anypoint.mulesoft.com/rhel/$releasever/main
gpgcheck=1
gpgkey=https://flex-packages.anypoint.mulesoft.com/rhel/pubkey.gpg
repo_gpgcheck=1
enabled=1
EOF

sudo yum install -y flex-gateway
```

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run). For more detail, see
[Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-centos-logo.png) CentOS

Download and install Omni Gateway as a CentOS service

##### Software Requirements

Omni Gateway runs on the following Long Term Support (LTS) version of CentOS:

- CentOS 8

##### Before You Begin

Before getting started, ensure that you have installed the following:

- [gnupg2](https://gnupg.org/)

##### Run Installation Commands

To download and install Omni Gateway as an CentOS service, run the command block that performs the
following actions:

- Adds the Omni Gateway package repository with a reference to its public key

- Installs the Omni Gateway package

```ssh
sudo tee /etc/yum.repos.d/flex-gateway.repo <<\EOF
[flex-gateway]
name = Anypoint Flex Gateway
baseurl = https://flex-packages.anypoint.mulesoft.com/centos/$releasever/main
gpgcheck=1
gpgkey=https://flex-packages.anypoint.mulesoft.com/centos/pubkey.gpg
repo_gpgcheck=1
enabled=1
EOF

sudo yum install -y flex-gateway
```

Due to issues with the CentOS package manager you might encounter the following error:

Error: Failed to download metadata for repo 'AppStream': Cannot prepare internal mirrorlist: No URLs
in mirrorlist

If you encounter this error, run the following command:

```ssh
sudo sed -i -e "s|mirrorlist=|#mirrorlist=|g" -e "s|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g" /etc/yum.repos.d/CentOS-*
```

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run). For more detail, see
[Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

## Download Omni Gateway for Use in a Container

You can download and install Omni Gateway in one of the following containers:

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-docker-logo.png) Docker

Download Omni Gateway for Use in a Docker Container

Download the Omni Gateway container image to prepare for registering and running a gateway in a
Docker container:

1.  Download the Omni Gateway Docker image:

    ```ssh
    docker pull mulesoft/flex-gateway:latest
    ```

2.  Verify that the download succeeded:

    ```ssh
    docker images mulesoft/flex-gateway
    ```

    When successful, the command lists the Omni Gateway container image, for example:

    ```text
    REPOSITORY                   TAG
    mulesoft/flex-gateway        latest
    ```

For deployments using Docker images, add the Omni Gateway Docker image to your Docker registry to
ensure the image is available in the event of a Dockerhub outage.

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

For more detail, see [Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

#### ![2%](/mulesoft/current/en-us/gateway/latest/_images/install-podman-logo.png) Podman

Download Omni Gateway for Use in a Podman Container

Download the Omni Gateway container image to prepare for registering and running a gateway in a
Podman container:

1.  Download the Omni Gateway container image:

    ```ssh
    podman pull docker.io/mulesoft/flex-gateway:latest
    ```

2.  Verify that the download succeeded:

    ```ssh
    podman images docker.io/mulesoft/flex-gateway
    ```

    When successful, the command lists the Omni Gateway container image, for example:

    ```text
    REPOSITORY                   TAG
    mulesoft/flex-gateway        latest
    ```

For deployments using Docker images, add the Omni Gateway Docker image to your Docker registry to
ensure the image is available in the event of a Dockerhub outage.

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

For more detail, see [Connected Mode vs. Local Mode](https://docs.mulesoft.com/gateway/latest/#connected-mode-vs-local-mode).

## Download Omni Gateway for Use in a Kubernetes Cluster

Download the Omni Gateway container image to prepare for registering and running a gateway in a
Kubernetes cluster. You can use the following container runtimes:

**Docker**

1.  Download the Omni Gateway container image:

    ```ssh
    docker pull mulesoft/flex-gateway:latest
    ```

2.  Verify that the download succeeded:

    ```ssh
    docker images mulesoft/flex-gateway
    ```

    When successful, the command lists the Omni Gateway container image, for example:

    ```text
    REPOSITORY                   TAG
    mulesoft/flex-gateway        latest
    ```

For deployments using Docker images, add the Omni Gateway Docker image to your Docker registry to
ensure the image is available in the event of a Dockerhub outage.

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

After downloading the image, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

**Podman**

1.  Download the Omni Gateway container image:

    ```ssh
    podman pull docker.io/mulesoft/flex-gateway:latest
    ```

2.  Verify that the download succeeded:

    ```ssh
    podman images docker.io/mulesoft/flex-gateway
    ```

    When successful, the command lists the Omni Gateway container image, for example:

    ```text
    REPOSITORY                   TAG
    mulesoft/flex-gateway        latest
    ```

For deployments using Docker images, add the Omni Gateway Docker image to your Docker registry to
ensure the image is available in the event of a Dockerhub outage.

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

After downloading the image, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

## Download Omni Gateway for Use in an OpenShift Cluster

Download the Omni Gateway container image to prepare for registering and running a gateway in an
OpenShift cluster. You can use the following container runtimes:

**Docker**

1.  Download the Omni Gateway container image:

    ```ssh
    docker pull mulesoft/flex-gateway:latest
    ```

2.  Verify that the download succeeded:

    ```ssh
    docker images mulesoft/flex-gateway
    ```

    When successful, the command lists the Omni Gateway container image, for example:

    ```text
    REPOSITORY                   TAG
    mulesoft/flex-gateway        latest
    ```

For deployments using Docker images, add the Omni Gateway Docker image to your Docker registry to
ensure the image is available in the event of a Dockerhub outage.

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

After downloading the image, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

**Podman**

1.  Download the Omni Gateway container image:

    ```ssh
    podman pull docker.io/mulesoft/flex-gateway:latest
    ```

2.  Verify that the download succeeded:

    ```ssh
    podman images docker.io/mulesoft/flex-gateway
    ```

    When successful, the command lists the Omni Gateway container image, for example:

    ```text
    REPOSITORY                   TAG
    mulesoft/flex-gateway        latest
    ```

For deployments using Docker images, add the Omni Gateway Docker image to your Docker registry to
ensure the image is available in the event of a Dockerhub outage.

After downloading and installing, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

After downloading the image, register Omni Gateway in [Connected](https://docs.mulesoft.com/gateway/latest/conn-reg-run) or
[Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run).

## See Also

- [Getting Started with Self-Managed Omni Gateway](https://docs.mulesoft.com/gateway/latest/gateway-getting-started)

- [Requirements and Limits for Omni Gateway](https://docs.mulesoft.com/gateway/latest/review-prerequisites)

- [Registering and Running Omni Gateway in Connected Mode](https://docs.mulesoft.com/gateway/latest/conn-reg-run)

- [Registering and Running Omni Gateway in Local Mode](https://docs.mulesoft.com/gateway/latest/local-reg-run)