Setting up Helix authentication

Important

Before you set up Helix authentication, make sure you review Helix authentication prerequisites.

The following information explains how to set up your Helix DAM instance with Helix Core Server authentication, which is required.

An unlicensed Helix Core Server is limited to 10 repositories. For more information, see Helix Core Server Licenses, which includes a license for Helix Core Server.

For additional information about Helix authentication:

Warning

After you configure Helix authentication and the Helix DAM instance is in use, you cannot revert to a different authentication method.

  1. Log in to the Helix TeamHub admin UI. See Logging in to the Helix TeamHub admin UI.

  2. When prompted, enter your license information and click Apply.

  3. Click Preferences.

    The Preferences page opens.

    Note

    Some options are dependent on others and are only displayed if required. For example, the option to add fingerprints only displays if TeamHub detects a P4PORT value that starts with SSL.

  4. Enter the Hostname of your TeamHub instance.

  5. In the Authentication section, select Helix.

  6. In the Helix Core Server section, enter or select information in each area:

    • P4PORT value - The host (name or IP address) and port for the Helix server, in the following format: host:port.

    • Fingerprint - If you connect to Helix Core Server using an SSL connection, add a fingerprint of the key received for SSL connections. If the fingerprint changes (or expires), you can add more fingerprints and delete outdated fingerprints. This is the equivalent of running the p4 trust command in the P4 command line. For details, see the Helix Core Command-Line (P4) Reference.

      Warning

      Deleting a fingerprint configured for the port removes the trust established with Helix Core Server. As a result, everything in TeamHub stops working against the respective SSL port

    • Helix integration user
      • Username - Enter the username of an existing Helix Core Server user with super privileges. This user must have unlimited ticket timeout.
        • Note

        You cannot change a username (or email address) in Helix Core Server. Instead, you need to make this change on the Helix Core Server side and wait for the sync.

        The Helix integration user does not count against your TeamHub license plan seats but each user requires a background license. Request background licenses using the Background user request form on the Perforce website.

      • Ticket/Password - The password/ticket for the existing Helix Core Server user with super level privileges. The existing Helix Core Server user must be a member of a group that has an unlimited timeout set for the session and password. See Creating a super user on the Helix Core Server.

      • Charset - Select the character encoding set for Helix Core Server, such as utf8 or none. To find the Helix Core Server charset, run: p4 -ztag info. When connecting to a non-unicode server, the charset is none by default. If the charset is not shown, select none from the list. For more information on Helix Core Server charsets, run: p4 help charset

    • Account and group synchronization

  7. Click Test Helix Core connection and wait for a message to be displayed: Successfully connected to Helix.

  1. Click Save preferences.

    A warning is displayed because the changes have not been applied to the server yet.

  2. Click Run reconfigure to apply the server configuration changes. See Reconfiguring Helix DAM to apply server configuration changes.

    3. Warning

    Failure to reconfigure may result in normal web server interruption messages, such as the HTTP Error 503. The service is unavailable. error, because the services come back online.