Helix authentication prerequisites

Important

The following information only applies to manual Helix DAM deployment. Do not follow these steps if you are using the automated deployment.

Helix DAM can only host assets stored in a Helix Core Server Stream depot. You must configure Helix authentication for the Helix DAM instance. Review the following information before setting up Helix authentication. See Setting up Helix authentication.

You need:

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

    • Helix DAM 2023.5 or later. We recommend at least 3-4 GB of memory and proper provisioning.

    • Only assets stored in Helix Core Server Stream depots or classic (local) depots are available in Helix DAM.

      Helix DAM works with supported versions of Helix Core Server (Standard Maintenance).

      The versions supported in this release of Helix DAM are (latest patch of server version required):

      • Helix Core Server 2023.1

      • Helix Core Server 2023.2

      • Helix Core Server 2024.1

      We recommend a server security level of 1 or higher. To learn more, see Server security levels in the Helix Core Server Administrator Guide.

    • Helix Search support:

      • Helix Search 2024.4 and later with improved index scalability (recommended): Helix DAM 2024.6 and later.

      • Helix Search 2024.3 and later with improved indexing speeds: Helix DAM 2024.5 and later.

      • Helix Search 2024.2 and earlier: All versions of Helix DAM.

  • One background Helix Core Server license seat for each integration Bot to give them access to Helix Core Server. For instructions on how to calculate the number of licensed seats you need, see Helix DAM license.

  • One Helix Core license seat to give Helix DAM super level access to Helix Core Server with an optional unlimited timeout ticket if ticket-based authentication will be used (recommended). For more information, see Setting protections with p4 protect and Ticket-based authentication in Helix Core Server Administrator Guide.

  • Two Helix Core Server license seats for Helix Search. If the Helix Core Server is security level 4 or lower, the number of licenses can be reduced to 1 by using the same user license for the Helix Search Perforce Service user and the Perforce Index user. This means the Helix Search Perforce Service user will have super level access. See Helix Core users in the Helix Core Search Developer Guide.

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

    Note

    Make sure that the names of Helix Core Server users that need access to Helix DAM do not exceed 100 characters. Helix DAM only supports usernames up to 100 characters.

  • An entry in the protections table for all users who require access to Helix DAM. To learn more, see Setting protections with p4 protect in the Helix Core Server Administrator Guide. The user used for integration requires super access in the protections table to view and manage protections.

Warning

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

High level architecture diagram

To get a better understanding of the underlying architecture, the following diagram gives a high-level overview of the architecture:

High-level overview of Helix authentication architecture