How to install Network Connector
  • 4 minutes to read
  • Dark
    Light
  • PDF

How to install Network Connector

  • Dark
    Light
  • PDF

Article summary

In this document, you will find a step-by-step guide on how to install the Network Connector.

Divide the installation and configuration of the Network Connector into the following steps:

  1. Configuration of the Network Connector Server.
  2. Registration of agents in senhasegura PAM.
  3. Get the Network Connector Fingerprint.
  4. Install the Network Connector Agent.
  5. Set the Network Connector Agent version.

Requirements

  • For 250 simultaneous connections per active SNC - 1 GB memory, 1 VCPU, 1GB network card, and at least 40GB available storage.
  • For 750 simultaneous connections per active SNC - 2 GB memory, 2 VCPU, and 1 GB network card, at least 40 GB available storage.
  • For 1500 simultaneous connections per active SNC - 4 GB memory, 4 VCPU, and 1 GB network card, at least 40 GB of available storage.

The server needs to be configured only once. The agent must be installed and configured on all networks that senhasegura cannot access.

1. Configure the Network Connector Server

The configuration of the Network Connector Server is carried out in the senhasegura instances with the orbit network-connector command.

Info

Run the command orbit network-connector --help to see all the options available for this command.

For these commands to have the expected result, it is necessary to have sudo administrator access to the senhasegura server, and the TCP/51445 port must be free so that the agent can communicate with the server.

Important

For cluster installations, it is necessary to configure the Network Connector Server on all nodes. To do this, 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 senhasegura instance in the cluster via terminal and run sudo orbit network-connector setup.
  2. Enter the Y key to confirm the operation.

The operation may succeed and return a success message:

senhasegura Network Connector Server is ready!

Use this fingerprint in senhasegura Network Connector Agents setup: "FINGERPRINT"

Instructions for starting senhasegura Network Connector Agents are available in our help center if you need them.

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 senhasegura 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 senhasegura 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 senhasegura

After activating the Network Connector Server, access the senhasegura web interface and follow the steps below:

  1. In senhasegura, access the Connectors page, through the path Grid menu > Devices > Settings > Network Connector > Connectors.
  2. In the Action column, click the Change icon.
  3. Click on the Agents tab.
  4. Add all the agents you want to install, filling in the Name and Port fields. The port must be between 30000 and 30999.
  5. Click the Save button.

3. Get the Network Connector Fingerprint

You must have the fingerprint generated during the Network Connector Server configuration process to install the agents.

To copy the fingerprint, follow the steps below:

  1. In senhasegura, access the Connectors page, through the path Grid menu > Devices > Settings > Network Connector > Connectors.
  2. In the Action column, click the Details option.
  3. When opening the window, click the fingerprint icon.
  4. Finally, just copy the value presented.

4. Install Network Connector Agent

To install the Network Connector Agent you need to have basic knowledge of Docker and Docker Compose.

Furthermore, the environment where the agent and the Linux server (any distribution) has Docker Compose Standalone must be installed and configured. When installing Docker Compose on the Linux server, use the Linux Standalone binary.

Important

Do not install the Network Connector Agent on senhasegura instances.

To install the Network Connector Agent, follow the steps below:

  1. On a Linux machine that meets the requirements described above and is a network to which senhasegura cannot access.
  2. Write the docker-compose.yml file with the agent settings (example below).
    • Pay attention to the fields:
      • SENHASEGURA_FINGERPRINT: value obtained previously.
      • SENHASEGURA_AGENT_PORT: define 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 senhasegura instances, separated by commas, without spaces. Example: 192.168.10.20,192.168.10.21.
      • SENHASEGURA_AGENT_SECONDARY: optional field. Can be true or false.
  3. Run the command sudo docker-compose up -d.

Example of the docker-compose.yml 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 monitor the agent execution logs using the sudo docker-compose logs -f command.

5. Set agent version

You can alter the agent version by changing the container image's version within the docker-compose.yml file.

If you leave it as per the examples above, with the latest option, 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 senhasegura used by the agent at the time.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.