Install Banyan Connector using the Tarball Installer

Install the Connector on Virtual or Physical 64-bit Linux Servers, On-Prem or Cloud

  • Updated on Jul 13, 2022

Network Reachability Checklist

  1. The Connector needs to be able to connect outbound to the Internet; it does not need any inbound open ports to operate correctly.

  2. Ensure that the Connector server can make an outbound HTTPS connection via port 443 to the Command Center. The Connector does this to register itself and receive its configuration parameters, by making API calls to https://{ccname}….

  3. Ensure that the Connector can make an outbound UDP connection to the Banyan Global Edge Network. The Connector will pick a port(s) in the range 30000 - 32767 to set up a Wireguard tunnel(s) with the Edge Network.

  4. Ensure your networking policies allow traffic to flow from the Connector server to backend machines running the applications and services you need to secure access to.

Register Connector

In the Banyan Command Center, navigate to Settings > API Keys and make sure you have created an API Key that can be used to register your Connector.

Create API Key

Then, navigate to the Infrastructure > Connectors section, and click on Add Connector to create your Connector.

Create Connector

Specify the API Key to use, the Cluster and Access Tier(s) you want your Connector to connect to. You can leave all the other fields at their default / empty values.

Once your Connector has been created in the UI, you can proceed to your Linux server to install the connector binary.

Supported Operating Systems

The connector binary can be installed on Virtual or Physical 64-bit Linux Servers.

Banyan’s Connector leverages Wireguard to set up secure tunnels. If your Linux version natively supports Wireguard in the kernel, the Connector will use that capability. If your Linux version doesn’t support Wireguard in the kernel, the Connector will fallback to its user-space implementation.


Ensure you have assumed root privileges:

user@host$ sudo su -

Download and extract the Tarball installer, and cd into the directory:

# create folder for the Tarball
mkdir -p /opt/banyan-packages
cd /opt/banyan-packages

# download and unzip the files
tar zxf connector-1.4.0.tar.gz
cd connector-1.4.0

Connectivity Parameters

Before you start the Connector binary, specify how it should connect to the Command Center so it can register itself and receive its configuration.

# edit the `connector-config.yaml` file to specify the Connector name and Command Center connectivity parameters
#  command_center_url:  # Banyan Command Center, such as
#  api_key_secret: 		# secret API Key associated with your Connector
#  connector_name		# name of your Connector

vi connector-config.yaml


# double check the configuration params
cat connector-config.yaml

# run the setup script so connector can be managed using systemctl

# manage using systemctl  
sudo systemctl [start|stop|status] connector

Verify Installation

Once the Connector is running, you can check its logs on the host at /var/log/banyan/connector.log to ensure it is functioning as expected.

In the Infrastructure > Connectors section of the Banyan Command Center to see the list of all the registered Connectors. Verify the status of your Connector there.

Connector Status