Features and Functionality
The user interface provides a consistent experience across all JFrog products. It is designed to support the most commonly used workflows, including improved package management, security and compliance, and package distribution, continuing to provide you with full flexibility. To support this experience the internal architecture (defined as a JPD) is designed to provide JFrog users with the same user experience across the JFrog products that have been installed.
To support the different user workflows, the UI is divided into two main modules:
Application Module providing an easy to use interface for viewing your packages, builds and artifacts in Artifactory. Including Xray security vulnerabilities and violations, Dashboard topology and trends, Distribution release bundles and Pipelines DevOps automation.
- Administration Module providing a consolidated place for configurations of all JFrog products (common and product specific). Including centralized settings, such as monitoring (storage, replication, service status), security and compliance, proxies, license and user management. As well as, property sets, backups, indexed resources, database sync and webhooks.
Both modules include an advanced search mechanism.
Flexible Permissions Model
Administrators get fine-grained permissions control over how users and groups access the different resources (repositories, builds, Release Bundles, destinations).
Security and Compliance Across your DevOps Pipeline
Fully integrated into the JFrog Platform, JFrog Xray protects your artifacts, repositories, builds and release bundles across the entire CI/CD pipeline.
- Get JFrog's vulnerability database that is continuously updated with new component vulnerability data. Including VulnDB, the industry's most comprehensive security vulnerability database.
- Identify security vulnerabilities and license violations according to your organization's needs. A dedicated Security and Compliance section in the UI allows you to set policies and watches on all your JFrog resources.
- Configure watches and policies with the option to block artifact download, Release Bundle distribution to Edge nodes, and even break Builds.
- Use advanced filtering that allows you to configure include /exclude patterns when setting indexed resources or when setting a Watch on the resources.
The JFrog platform installation/upgrade includes the following highlights:
- Common system directory structure for the product application and variables (configurations, data and log)
- Flexible System YAML Configuration Files enabling easy automation
- Alignment of all installers user experience and compatibility matrix
Secure Distribution Process
Manage the creation and distribution of Release Bundles to your Artifactory Edge Nodes. Gain better visibility and traceability into your distribution process with a complete view of all contents and package references of your Release Bundles.
The following table is a quick reference to common functionalities in the JFrog Platform, including their new locations and any functional changes.
Location in the New UI
|Custom Base URL|
Look and Feel Settings
Administration module | General | Settings
|Dedicated Artifactory Settings|
Administration module | Artifactory
General: Settings, Property Sets, HTTP Settings
Services: Backups, Maven Indexer
Security: Anonymous access, Revoke API Keys, SSH Server, Signing Keys Trusted Keys, Certificated
Administration module | Identity and Access | Permissions
As part of the JFrog Platform permissions unification, permission targets that were previously separated per product are now represented as one permission target with multiple permission options for the different JFrog products. Changes include:
As part of the permission migration process:
- Users/Groups with Xray Admin and Artifactory Admin permissions will be converted to Administrators in the JFrog Platform.
- Users/Groups with only Xray Admin permissions will be converted to have
Manage Policies and
Manage Watch permissions on all the resources.
For more information, see JFrog Platform Permission Migration.
Administration module | Identity and Access | Users
Administration module | Identity and Access | Groups
- Manage Policies and Manage Watches are now a global permissions that are enabled on the user or group level. Previously this was a permission option in the permission target.
- View Watches is now integrated with the Manage Watches global permission. It is not available as a separate permission.
|Policies and Watches|
Application module | Security & Compliance
- Watch resources scope of repositories, builds and Release Bundles can be set by name or by Exclude/Include Patterns.
- Manually invoking a re-scan of a watch will apply on all resources defined in the watch. Previously you could set the re-scan on part of the resources.
|Dedicated Xray Settings|
Administration module | Xray
General: Indexed Resources, Database Sync, Webhooks, Integrations
Advanced: System Parameters and Queue Workers, Xray System Messages, etc.
- When setting the indexed resources scope of repositories, builds and Release Bundles you now set by name or by Exclude/Include Patterns.
|Release Bundles are scanned by Xray|
- JFrog Xray supports indexing and scanning of Release Bundles as well as defining Watches and Policies on Release Bundles. You can apply a policy on a Watch containing a Block Release Bundle Distribution action to prevent distributing a Release Bundle to edge nodes if it meets a security or License policy defined in JFrog Xray. For more information, see Xray Scanning of Release Bundles.
Administration module | Identity and Access | Access Federation
Administration module | Platform Deployments | Services
Administration module | Monitoring | Service Status
|License and Licence Buckets|
Administration module | License Management
|Consolidated Licenses for all the JFrog products.|
Mission Control Site Explorer
Application module | Dashboard | Topology
|Dashboard displays JPD topology.|
Mission Control Insight
Application module | Dashboard | Trends
|Distributable and Received Release Bundles|
Application module | Distribution
The following table describes features that are currently under development and will be available in later JFrog Platform releases.
Not available in the initial JFrog Platform release.
License Control is deprecated. Its functionality is included in the Xray integration and provides richer information and support for additional package types.
Stash Search Results: allowing you to save your search results and go back to them later, has been removed.
- User Plugins: Now is a good time to check the READMEs of any user plugins you got from our User Plugins GitHub to ensure they are still valid and relevant. All non-deprecated plugins should now work with Artifactory 7.x. If you wrote a custom user plugin that relies on a non-public API you should test it in Artifactory 7.x before deploying to production.
AJP Connector has been removed and will no longer work, HTTP should be used as an alternative.
Out of the box integrations: Aqua, WhiteSource and Black Duck, out of the box integrations are deprecated in the Xray UI integrations page.
However, custom integrations are still available, supporting integrating to any external source of your choice. The VulnDB integration, now transparently integrated into Xray, provides the industry's most comprehensive security vulnerability database. This eliminates the need for these out of the box 3rd party integrations.
- Xray Homepage: as part of the JFrog Platform UI unification, this page has been removed.
- Scripts are deprecated in favour of using the CLI.
- Disaster Recovery is deprecated.
|Internet Explorer||The Internet Explorer browser is not supported in the JFrog Platform. For a list of supported browsers, see Browsers.|
When upgrading to Artifactory version 7.x from a previous major version (e.g. 6.x), all other associated JFrog services must be upgraded to these compatible versions:
Artifactory 7.x will not work with any previous major versions of these services.
Additionally, none of these new versions of Mission Control(4.x), Xray(3.x), or Distribution(2.x) will be compatible with Artifactory 6.x.
When upgrading to the JFrog Platform, Xray must be connected only to a single Artifactory instance. If you have one Xray instance connected to more than one Artifactory instances, use one of the following options before proceeding with any upgrade:
Option 1 (recommended): Keep one connected Artifactory instance to your single Xray instance, and upgrade the rest to version 7.x with newly installed Xray version 3.x instances. This option will require re-indexing the additional Artifactory instances, and will cause some loss of configuration data. Learn More >
Option 2: Install additional Xray version 2.x instances for each Artifactory instance that you have, and restore all MongoDB and PostgreSQL data. Continue to upgrade each Artifactory and Xray pairs to version 7.x and version 3.x. This procedure is only suggested if you must keep all your Xray configurations and easily reconfigure them in the new instances. Learn More >
- with an Oracle database requires a new driver and setup. See details here.
- MongoDB database, used by Xray prior to the Platform, is no longer needed (except during the data migration). If you are upgrading to the new JFrog Platform, your data will be automatically migrated over to PostgreSQL as part of the upgrade process.
- Inter-product communication
- Custom logback and Sumo Logic Integration
- Directory structure: has been updated for all JFrog products to create a standardized structure.
- HA: HA installations with a shared NFS that mount the
/data directory should now mount the
- Logs structure has been updated from version 6.x, additional logs for new microservices have been added, log names have been changed to be aligned with all products and log output format has been changed to be aligned with all products.
- Log file names are now prefixed by the service name and a dash. For example, the Artifactory log file name has been changed from application.log to artifactory-service.log.
- Additional logs are now included for the new Router, Metadata, and Frontend.
- no longer configure an Artifactory as an Authentication Provider for Authentication as the new JFrog Platform architecture is based on a join-key method that automatically connects between the JPD and its services.
For more information, see System Architecture.
- Accessing the UI: The JFrog Platform web UI is now accessed through port 8082 (For example,
http://SERVER_HOSTNAME:8082/ui/). Accessing Artifactory directly for REST API and downloads is still possible through port 8081. For more information, see System Requirements.
- Reverse Proxy: The reverse proxy configuration should only be configured for the JFrog Platform, where previously it was configured for each JFrog Product separately. You will need to create a new reverse proxy configuration.
- Load balancer health check endpoint: has been changed from
/router/api/v1/system/ping. See instructions here.
- Using a Custom Context Path for OAuth or SAML SSO Authentication Providers: You will receive an error from your Identity Provider, if you have configured OAuth or your SAML SSO authentication providers, in versions prior to Artifactory 7.x, with the following settings:
- Your Artifactory Context path was set using a custom context path, for example,
mycompany.com/mycompany_test. To preserve this configuration, set the following system property,
artifactory.override.context.path as your custom context path.
- You are using an empty context path, for example: mycompany.com/. To continue using the emtpy context path configuration, set the following system property
artifactory.override.context.path=Empty in the
- Component Search: searching for components that are not artifacts in your Artifactory instance, but are known to Xray as a result of its recursive scan capability. This functionality will be available in later JFrog Platform releases.
- Xray Permissions
Manage Watch permission is now available as a global permission on the user/group level. Previously manage watches was an option per permission target that was defined with a scope of resources. Now, users/groups with the
Manage Watch permission will enable permissions for all resources. When upgrading to the JFrog Platform, the permission conversion will remove the Manage Watch permission for all users and groups. After upgrading, this permission will need to be reconfigured for all required users and groups. Defining a scope will be available in later JFrog Platform releases, as part of the Projects functionality.
View Watches permission is deprecated. To view watches, enable the
Manage Watches permission option for users/groups.
REST API Changes
The JFrog Platform release introduces a new unified way to access all JFrog services, with the exception of Artifactory, using a single
port, using the following format:
<JFrog Base URL>:<Router Port>/<Service Context>/api/<Version>
JFrog Artifactory will continue to work as before,
<JFrog Base URL>:<Artifactory Port>/artifactory/api/
The REST API documentation for all JFrog products has been updated to use the new shared base url.
Note: For backward compatibility, each JFrog product will continue to have its own server_url and port.
The following table summarizes the list of changes from previous JFrog products versions to the JFrog Platform.