Basic Settings for Local Repositories

JFrog Artifactory Documentation
Products
JFrog Artifactory
Content Type
User Guide
New_Local_repo.png

The following basic settings are common for all package types.

Setting

Description

Package Type

The package type must be specified when the repository is created, and once set, cannot be changed.

Repository Key

The repository key is a mandatory, unique identifier for the repository. It cannot begin with a number or contain spaces or special characters.

Stage

Defines one or more stages in which this repository will reside. Stages aggregate project resources (repositories, Pipeline sources, etc.) to simplify their management. For more information, see Stages & Lifecycle.Stages & Lifecycle

Note

Defining a stage is mandatory when creating a repository within a specific project. The default selection is DEV.Projects

Repository Layout

Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested.

Public Description

A free text field that describes the content and purpose of the repository. This description can be viewed by all users with access to the repository.

Internal Description

A free text field to add additional notes about the repository. These notes are visible only to the administrator.

Include and Exclude Patterns

The Include Patterns and Exclude Patterns fields allow you to filter out specific repositories when resolving the location of different artifacts.

In each field, you can specify a list of Ant-like patterns to filter in and filter out artifact queries. Filtering works by subtracting the excluded patterns (default is none) from the included patterns (default is all).

Note

If you remove the "include all" default setting (**/*) by clicking on the X at the right end of the row, the "include all" default setting is removed from the UI but it is still in effect.

Example:

Consider that the Include Patterns and Exclude Patterns for a repository are as follows:

  • Include Patterns: org/apache/**,com/acme/**

  • Exclude Patterns: com/acme/exp-project/**

In this example, the repository is searched for org/apache/maven/parent/1/1.pom and com/acme/project-x/core/1.0/nit-1.0.jar, but not for com/acme/exp-project/core/1.1/san-1.1.jar because com/acme/exp-project/** is specified as an Exclude pattern.

Important

Include and exclude patterns apply to regular users. Admin users can see all items regardless of the patterns defined here.

Enable Indexing in Xray

JFrog Xray enables repository indexing for security and compliance analysis of the following package types:

Supported Package Types

Unsupported Package Types

Docker

npm

Maven

PyPI

Gradle

Go

Debian

RPM

Terraform BE

Alpine

Bower

Cargo

Conan

Conda

CRAN

Gems

Ivy

NuGet

Composer

SBT

Generic

HuggingFace

Swift

Terraform

Chef

CocoaPods

GitLfs

Helm

Opkg

Pub

Puppet

Vagrant

Important

For information about specific settings for particular package types, see Additional Local Repository Settings for Specific Package Types.