--- title: "How to install Network Connector" slug: "network-connector-how-to-install-network-connector" updated: 2026-11-03T14:47:51Z published: 2026-11-03T14:47:51Z canonical: "docs.senhasegura.io/network-connector-how-to-install-network-connector" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.senhasegura.io/llms.txt > Use this file to discover all available pages before exploring further. # How to install Network Connector In this document, you’ll find a step-by-step guide on how to install the **Network Connector**. The installation and configuration of the **Network Connector** is divided into the following steps: 1. Configure the **Network Connector Server**. 2. Register agents in Segura™ **PAM**. 3. Obtain the **Network Connector Fingerprint**. 4. Install the **Network Connector Agent**. 5. Set the version of the **Network Connector Agent**. ## Requirements - Root access to the Docker host machine. - Docker and Docker Compose (maintained by the customer). - Outbound connectivity to Segura™ instances on port 51445 with WebSocket support. - Outbound access to `registry.senhasegura.io` and `us-docker.pkg.dev` on port 443 for the agent setup. - Recommended having at least two Network Connector agents running and configured. - SSL Inspection disabled on the firewall. ### Hardware requirements | Simultaneous connections | Memory | vCPUs | Network card | Storage | | --- | --- | --- | --- | --- | | 500 | 1 GB | 1 | 1 Gbps | At least 40 GB of storage | | 1000 | 2 GB | 2 | 1 Gbps | At least 40 GB of storage | | 2000 | 4 GB | 4 | 1 Gbps | At least 40 GB of storage | Info The number of simultaneous connections is directly related to the hardware of your Segura™ server running the sessions. The NC agent only redirects network traffic, but the Segura™ server handles the remote sessions. Therefore, the NC agent limitation will always be associated with the Segura™ server limitation. The server needs to be configured only once. The agent, in turn, must be installed and configured on all networks that Segura™ does not have access to. ## 1. Configure the Network Connector Server The configuration of the **Network Connector Server** is carried out in the Segura™ instances with the command `orbit network-connector`. Info Run the command `orbit network-connector --help` to know all the options available for this command. For these commands to have the expected result, you must have administrator access `sudo` to the Segura™ server and the port `TCP/51445` must be released for the agent to communicate with the server. Important For cluster installations, it is necessary to configure the **Network Connector Server** at all nodes. To do this, simply repeat the steps above on each node in the cluster. Follow the steps below to install and configure the **Network Connector Server**: 1. Access each Segura™ instance in the cluster via terminal and run the command `sudo orbit network-connector setup`. 2. Enter the `Y` key to confirm the operation. The operation may succeed and return a success message: ``` Segura® Network Connector Server is ready! Use this fingerprint in Segura® Network Connector Agents setup: "FINGERPRINT" In case you need it, instructions for starting Segura® Network Connector Agents are available in our help center. See at https://d.senhasegura.io/skme2rugfyizbw9 NOTE: If this environment is in cluster mode, run "sudo orbit network-connector setup" on secondary nodes as well ``` Or unsuccessful and return one of the errors below: ``` Can't continue setup. This node is a Secondary in cluster and Segura® Network Connector Server needs to be initialized in Primary node. Please run "sudo orbit network-connector setup" in Primary node first. ==================================or===================================== Whoops! An error was found in application setup. Check if application database is running and file replication between nodes is working without errors. ==================================or===================================== Whoops! An error was found! Unable to determine which fingerprint Segura® Network Connector Agents needs to connect in this server, try again later. ==================================or===================================== Whoops! Could not replicate settings to cluster nodes Check if all cluster nodes are available, file replication is working and try again. ``` ## 2. Register Network Connector Agents on Segura™ After activating the **Network Connector Server**, access the Segura™ web interface and follow the steps below: 1. On Segura™, access the **Connectors** page, using the path **Settings > Security policies and network > Network Connector > Network Connector**. 2. In the **Actions** column, click the **Edit** icon. 3. Click on the **Agents** tab. 4. Click on the **+ Add** button. 5. Add all the agents you want to install by filling the fields **Name** and **Port**. The port must be between 30000 and 30999. 6. Click the **Save** button. ## 3. Get the Network Connector Fingerprint To install the agents, you must have the fingerprint generated during the configuration process of the **Network Connector Server**. To copy the fingerprint, follow the steps below: 1. On Segura™, access the **Connectors** page, using the path **Settings > Security policies and network > Network Connector > Network Connector**. 2. In the **Actions** column, click the option **Details**. 3. When the window opens, click on the eye icon to reveal the fingerprint. 4. Select and copy the fingerprint. ## 4. Install the Network Connector Agent To install the **Network Connector Agent**, it is necessary to have basic knowledge of [Docker](https://docs.docker.com/engine/) and [Docker Compose](https://docs.docker.com/compose/). Furthermore, it’s necessary that the environment of the agent and the Linux server (any distribution) have the [Docker Compose Standalone](https://docs.docker.com/compose/install/standalone) installed and configured. When installing the [Docker Compose](https://docs.docker.com/compose/install/) on the Linux server, use the **Linux Standalone binary**. Important The **Network Connector Agent** must not be installed on Segura™ instances. To install the **Network Connector Agent**, follow the steps below: 1. On a Linux machine that meets the requirements described above and is on a network to which Segura™ does not have access. 2. Write the file `docker-compose.yaml` with agent settings (examples below). - Pay attention to the fields: - `SENHASEGURA_FINGERPRINT`: value obtained previously. - `SENHASEGURA_AGENT_PORT`: set a port between 30000 and 30999 for this agent. Choose one that is not in use. - `SENHASEGURA_ADDRESSES`: - In cases of standalone installation: IP address of the instance. Example: `192.168.10.20`. - In cases of cluster installation: IP addresses of the Segura™ instances, separated by commas, without spaces. Example: `192.168.10.20,192.168.10.21`. - `SENHASEGURA_AGENT_SECONDARY`: optional field. Could be `true` or `false`. 3. Run the command `sudo docker-compose up -d`. Example of the `docker-compose.yaml` file: ``` services: senhasegura-network-connector-agent: image: "registry.senhasegura.io/network-connector/agent-v2:latest" restart: unless-stopped networks: - senhasegura-network-connector environment: SENHASEGURA_FINGERPRINT: "CHANGE_ME" SENHASEGURA_AGENT_PORT: "CHANGE_ME" SENHASEGURA_ADDRESSES: "CHANGE_ME" SENHASEGURA_AGENT_SECONDARY: "false" networks: senhasegura-network-connector: driver: bridge ``` Info You can follow the agent execution logs using the command `sudo docker-compose logs -f`. ## 5. Set the agent version You can define the version of the agent to be used by changing the version of the container image. The choice is determined within the `docker-compose.yaml` file. If you leave it with the option `latest`, as in the examples above, you will be using the latest available version of the agent: `image: "registry.senhasegura.io/network-connector/agent-v2:latest"`. To use the agent in other versions, use `image: "registry.senhasegura.io/network-connector/agent-v2:3.32"`. Info Try to keep the agent version equivalent to the version of Segura™ used by the agent at the time. --- Do you still have questions? Reach out to the [Segura™ Community](https://community.senhasegura.io/).