Using with JFrog Artifactory
Tidelift integrates with JFrog Artifactory to help you keep only known-good open source approved in your repository manager. We integrate with Artifactory in both directions.
Our integration currently works with JFrog Artifactory version 7. If you are using an older version of JFrog Artifactory, please contact email@example.com.
1. Initial catalog creation (Artifactory → Tidelift)
- When creating your organization’s catalog, you can import a list of all open source package releases (e.g. each version of each package) currently in use at your organization from Artifactory.
- Upon successful import, Tidelift will provide guidance on each package release on whether or not we recommend including the package release and related release streams in your catalog. For example, we would not recommend including a package release with a security vulnerability in your organization’s catalog.
- You can choose to accept Tidelift’s version guidance or manually inspect each issue affecting a package release.
- Your initial catalog has now been created based on usage from JFrog Artifactory.
2. Updating Artifactory with what’s in the catalog (Tidelift → Artifactory)
The Tidelift → Artifactory integration will ensure that Artifactory contains an accurate representation of what’s in your Tidelift catalog. Every time a change is processed for your Tidelift catalog, we will update a tidelift.status property on the original artifact in Artifactory.
When tidelift.status is set to denied for a given package release, developers will receive a 403 Forbidden error when attempting to download the package for use from Artifactory.
3. How the Tidelift + Artifactory integration works
The Tidelift plugin will monitor all download event within Artifactory to block any artifacts with a tidelift.status of Denied from being downloaded. The download hook fires on every download request regardless of whether or not the package is in Artifactory already.
4. Setting up the Tidelift + Artifactory integration
For Artifactory 7.6+
Administration > General > Webhooks, with the following values:
Name: Tidelift URL: https://api.tidelift.com/external-api/artifactory/webhook Event: "Artifact was deployed" (and pick the Artifactory repositories you'll use for your Tidelift Catalog) Secret Token: <API key from the first step>
For Artifactory <7.6
curl -s -u admin:<admin password> -d "" $ARTIFACTORY_HOST/artifactory/api/plugins/execute/webhookReload.