Helix authentication prerequisites

Configuring Helix TeamHub with Helix authentication requires specific setup in Helix server. In particular, you need:

  • An installation of the following products, each on its own, dedicated machine:

    • Helix TeamHub 2018.1 or later

      We recommend at least 3-4GB of memory and proper provisioning.

    • Helix TeamHub works with supported versions of Helix server (Standard Maintenance).

      The versions supported in this release of TeamHub are:

      • Helix server 2019.1

      • Helix server 2019.2

      • Helix server 2020.1

      • Helix server 2020.2

      We recommend a server security level of +1. For more information, see Server security levels in the Helix Core Server Administrator Guide.

    • Helix4Git

    Warning

    If Helix TeamHub resides on the same machine as Helix4Git, port conflicts occur. For best results, we recommend setting up all 3 components on separate machines.

  • A Helix server license with the correct number of seats for your users, your gconn-user (Git Connector), and your Bots. For instructions on how to calculate the number of licensed seats you need, see TeamHub License.

  • super level access to Helix server with an optional unlimited timeout ticket if ticket-based authentication will be used (recommended).

    For more information, see Helix Core Server Administrator Guide, sections Setting protections with p4 protect and Ticket-based authentication.

  • Host name, protocol, port, and user information for the Git Connector

    For more information, see the Helix4Git Administrator Guide.

  • Admin permission for the gconn-user on any manually created graph depots

    For information on granting permissions, see the Helix4Git Administrator Guide, section Grant permissions.

  • Users with appropriate access to Helix server. All user and group administration occurs in Helix server.

    Note

    Make sure that the names of Helix server users that need access to Helix TeamHub do not exceed 100 characters. TeamHub only supports user names up to 100 characters.

  • An entry in the protections table for all users that need access to Helix TeamHub

    For more information, see Helix Core Server Administrator Guide, Setting protections with p4 protect.

    The admin user needs superuser access to the protections table to view permissions.

  • An access level of either admin or create-repo for users that need the ability to add repos in specific depots

    For more information, see Helix Core P4 Command Reference, p4 grant-permission command.

If you intend to install the TeamHub trigger, make sure the machine hosting Helix server has Perl 5.08+ and Perl Core on CentOS installed.

Warning

Once you have configured Helix authentication and the TeamHub instance is in use, it is not possible to revert back to a different authentication method.

To get a better understanding of the underlying architecture, the following figure provides a high-level overview.

High-level overview of Helix authentication architecture

Installation and configuration flow

The following table outlines the flow of setting up Helix authentication in Helix TeamHub and specifies the product it pertains to.

Step Description Product Instructions

1.

Install Helix TeamHub.

Helix TeamHub

Installation section in this manual

2.

If you start from a new Helix server, add users and groups in Helix server. For existing Helix server installations, verify that the protections table includes the required entries for the users that need access to Helix TeamHub.

Helix server

Add users and groups in Helix server in this manual

Helix Core Server Administrator Guide:

Helix Core P4 Command Reference:

3.

Configure TeamHub to use Helix server authentication.

Helix TeamHub

Set up Helix server authentication section in this manual

4.

Install triggers in Helix server to enable the activity stream in Helix TeamHub.

Helix server

Set up Helix trigger scripts for TeamHub in this manual

5.

Create a new project and repository.

Helix TeamHub

Helix TeamHub User Guide:

6.

Configure group access to the newly created project.

Helix TeamHub

Add users and groups in Helix server in this manual

7.

Clone the new repository to your local workspace.

Helix TeamHub

Helix TeamHub User Guide: