Using Artifactory 5.x ?
JFrog Artifactory 5.x User Guide
Have a question? Want to report an issue? Contact JFrog support
Artifactory provides you with the features you need to manage your binary repositories, both through an intuitive UI and with an extensive set of APIs.
The Artifactory UI is divided into five main modules:
The Home module serves as a dashboard where you can easily access general information and commonly used features. For more details, please refer to General Information.
The Artifacts module is used to browse the repositories in your system and search for artifacts using a number of different methods. While browsing through repositories, Artifactory displays useful information and provides you with tools to perform essential actions to manage your repositories.
The Search module is where you can search for Artifacts by name, package type, properties and a variety of additional methods offered by Artifactory. For more details, please refer to Searching for Artifacts.
The Build module displays the Build Browser where you can view all the CI server projects that output their builds to Artifactory. Here you can drill down to view detailed build information and compare one build to another.
The Admin tab is only available to users who are defined as administrators in the system, and is used to perform a variety of administration and maintenance activities such as:
- Configuring different entities such as repositories, software licenses, proxies, mail servers and more
- Managing different aspects of system security such as user definitions, groups, permissions, LDAP integration and more
- Managing backup and indexing of repositories
- Managing import and export of repositories or of the entire system
- Accessing system information and scheduling different cleanup operations
This functionality is available through the Admin menu which is displayed when a logged-in administrator hovers the mouse over Admin in the navigation bar.
To help locate a specific action, you can enter a search term in the Filter field and have Artifactory emphasize matching menu items.
In addition to the feature set offered by the UI, Artifactory provides an extensive REST API to facilitate integration with build automation and continuous integration systems.
On every screen of Artifactory, you can click the Help menu to display a list of help topics relevant for the current screen. Selecting any of the help topics opens a new browser tab displaying the corresponding Artifactory documentation.
Set Me Up
Artifactory's Set Me Up feature provides you with the commands you can use to deploy and resolve artifacts to and from specific repositories. Simply select any item in the Tree Browser or Simple Browser and click Set Me Up.
Regardless of what was selected when you pop up this dialog, you can select a Tool and a specific Repository (the list of repositories displayed corresponds to the tool you selected), and Artifactory will provide the relevant commands according to your selection.
Inserting User Credentials
Every Set Me Up dialog includes an "Insert Credentials" button. When pressed, Artifactory will prompt you for your password and will then replace generic credential placeholders used in code snippets with your own corresponding credentials.
This means that you may now copy the code snippets and use them "as is". For example, for the Set Me Up screen displayed above, clicking "Insert Credentials" will replace the
<API_KEY> placeholder with your API Key as displayed below.
To undo the change, click "Remove Credentials".
Inserted user data is not persistent
Once you close the Set Me Up dialog, any user data that was inserted is removed. To insert user data into code snippets, you need to invoke it each time you display a Set Me Up dialog.
To facilitate easy navigation through its UI, Artifactory offers the following set of keyboard shortcuts:
|Ctrl/Cmd + Alt + B||Display the Build Browser in the Build module|
|Ctrl/Cmd + Alt + R||Display the Artifact Repository Browser in the Artifacts module|
|Ctrl/Cmd + Alt + N||Create a new item (where relevant). For example, when viewing the list of local repositories, Ctrl/Cmd + Alt + N will pop up a dialog to create a new one.|
|Ctrl/Cmd + Alt + >||Open the Admin module menu. Once in the menu, you can browse through items using the up/down arrow keys or the tab key.|
|Ctrl/Cmd + Alt + <||Close the Admin module menu.|