synoti logosynoti logo
Federation Setup Installing the Federation Service

This guide covers the Federation Service installation process. It shows you how to install the Unified Security Stack Federation Service on your server by using the command line, and how to generate the API key required to authorize connections to your target Unified Security Stack instances.

Phase 1: Install the Federation Service

The first stage occurs in the command line interface (CLI) of the server that will host your Unified Security Stack Federation Service. The automated installer will download the necessary container images, including backend, frontend, and database, and will set up the services for you.

  1. 1

    Log in as superuser

    Access your server's terminal and elevate your privileges to ensure you have the necessary permissions to install software:

    sudo su
  2. 2

    Download the official installer

    Use the wget utility for downloading the installation script straight from the official Unified Security Stack updates repository.

    The Federation Service is only for Enterprise clients, and the dedicated download link will be sent to each user individually.

  3. 3

    Grant execution privileges

    Modify the permissions of the downloaded file so your system allows it to run:

    chmod +x installer
  4. 4

    Run the installer

    Initiate the automated installation process:

    ./installer

Be sure to store your initial credentials! Installation might take several minutes. Once it is complete, you will see a Installation finished successfully Once this is done, the terminal will show you the access URL, which is derived from your server's IP address, along with a unique access key. You must save this initial password so you can log in. Later, you can change it through the Federation User Interface.

Phase 2: Generate an API Key on the Target Instance

Before you can connect the Federation Service, you must create an API Key on the specific Unified Security Stack instance you want to monitor and manage. This key works as a secure bridge between the two systems.

  1. 1

    Access the target web interface

    Open your preferred web browser and navigate to the web interface of your target Unified Security Stack instance (for example, https://10.11.11.105).

  2. 2

    Navigate to API Keys

    Click on your user avatar located in the top-right corner and select the Settings icon. In the navigation menu on the left, find the Application Management section and click on API Keys.

  3. 3

    Create a new base API key

    Click the Create base API key button located at the top right of the screen.

  4. 4

    Configure the key parameters

    Complete the configuration dialog using the following guidelines:

    ParameterRecommended Setting
    NameProvide a descriptive and easily identifiable name (e.g., Federation Demo).
    Expires AtChoose an extended expiration date from the calendar, for example, the year 2030.
    Allowed IP'sEnter only the IP address of the server where you installed the Federation Service.

Setting an extended expiration date for your API key ensures that your Federation Service will not experience unexpected disconnections because of an expired token.

After your API key is generated and saved, your Federation Service is fully installed, and your target instance is ready for connection!