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.
- Create the
access.config.patch.ymlfile 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.ymland rename the copy toaccess.config.import.yml. Use this copy as the file in the steps below. Do not updateaccess.config.latest.yml. Upon the next Access restart, the import file is removed and becomes theaccess.config.latest.ymlfile. Artifactory 7.146.0 and later do not createaccess.config.latest.yml.
-
Open the file you created.
-
Add this line in the new file you created:
integrations-enabled: true. -
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. -
To make the integration page visible in the platform UI, set
accessIntegrationtotrueusing one of the following options (both methods produce the same outcome — select whichever works best for you):-
Add the environment variable
JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATIONand set it totrue. For Artifactory versions above 7.60, if using Kubernetes, add the environment variableJF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATIONto 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. -
Alternatively, in the
system.yaml, setaccessIntegration: trueas follows:Shared: featureToggler: accessIntegration: true
-
-
Restart Artifactory. This restarts the Access service, which loads the file you created and applies the settings in it.
Related Topics
Updated about 1 month ago
