New Integrations Enablement

Enable new JFrog Platform integrations by setting integrations-enabled: true in an Access YAML file.

To enable creating a new integration with the JFrog Platform, set the flag for new integrations in an Access YAML file.

  1. Create the access.config.patch.yml file in $JFROG_HOME/artifactory/var/etc/access/. The patch file merges its values into the current configuration, so it needs only the new integration settings.
📘

JFrog Artifactory 7.133.x and earlier

Instead of creating the patch file, copy access.config.latest.yml and rename the copy to access.config.import.yml. Use this copy as the file in the steps below. Do not update access.config.latest.yml. Upon the next Access restart, the import file is removed and becomes the access.config.latest.yml file. Artifactory 7.146.0 and later do not create access.config.latest.yml.

  1. Open the file you created.

  2. Add this line in the new file you created: integrations-enabled: true.

  3. Complete the details in integration-templates by adding the ID of the integration, the name and the template. For example:

    integrations-enabled: true 
    integration-templates: # list of possible integrations to create
      - id: "1"  # The id of the integration template, to save a reference back from the integration.
        name: "Slack integration" # The name of the integration as will appear in the UI when creating a new integration.
        redirect-uri: "https://my-jfrog-integrations.com/callback" # The redirect-uri that will direct users back to the integration client with the authorization code.
        scope: "applied-permissions/user" # Only this scope is currently supported.
        internal: false # Optional. Default false. Indicates whether it's an internal template, meaning will not be returned to UI unless specifically asked to include internal templates.
  4. To make the integration page visible in the platform UI, set accessIntegration to true using one of the following options (both methods produce the same outcome — select whichever works best for you):

    1. Add the environment variable JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION and set it to true. For Artifactory versions above 7.60, if using Kubernetes, add the environment variable JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION to the frontend container environment variables.

      frontend: 
        extraEnvironmentVariables: 
          - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION 
            value: "true" # meaning will not be returned to UI unless specifically asked to include internal templates.
    2. Alternatively, in the system.yaml, set accessIntegration: true as follows:

      Shared:
          featureToggler:
              accessIntegration: true
  5. Restart Artifactory. This restarts the Access service, which loads the file you created and applies the settings in it.

Related Topics


Did this page help you?