Create a VCS Repository

JFrog Artifactory Documentation
Products
JFrog Artifactory
Content Type
User Guide

This topic describes how to create a VCS Repository. This is required before publishing and installing VCS packages. Artifactory supports the following repository types for VCS packages:

  • Remote repositories: Enable you to download from any remote location, including external package registries or other Artifactory instances

    Note

    Artifactory does not support local or virtual repositories for VCS.

For more information on JFrog repositories, see Repository Management Overview.

Prerequisite:

  • You need to create a Remote Repository which serves as a caching proxy for github.com. If necessary, you can do the same for bitbucket.org or any other remote git repository that you need.

  • You need Admin or Project Admin permissions to create a VCS repository. If you don't have Admin permissions, the option will not be available.

Artifacts (such as tar.gz files) requested from a remote repository are cached on demand. You can remove downloaded artifacts from the remote repository cache. You can not manually deploy artifacts to a remote repository.

To create a VCS repository:

  1. In the Administration tab, click Repositories > Create a Repository and from the dropdown list select Remote. The Select Package Type screen appears.

    art-package-vcs-create-repo-15-09.png

  2. In the Select Package Type screen, select VCS.

  3. Set the Repository Key, and specify the URL to be https://github.com (or your GitHub Enterprise URL endpoint) as displayed below:

    art-package-vcs-create-repo-remote-15-09.png

  4. Scroll down to VCS Settings and select one of the following settings for the Git Provider:

    • GitHub Cloud: For repositories hosted on https://github.com.

      Example: https://github.com/myorg/myrepo.git

    • GitHub Server: For repositories hosted on a private GitHub Enterprise Server.

      Example: https://git.mycompany.com/myorg/myrepo.git

    • Bitbucket Cloud: For repositories hosted on https://bitbucket.org.

      Example: https://bitbucket.org/myorg/myrepo.git

    • Bitbucket Server: For repositories hosted on a self-managed Bitbucket Server or Bitbucket Data Center.

      Example: https://bitbucket.mycompany.com/scm/myproj/myrepo.git

    • Bitbucket Server (Stash prior to 5.1.0): For Atlassian Stash installations (Bitbucket prior to v5.1).

      Example: https://stash.mycompany.com/scm/myproj/myrepo.git

    • Artifactory: For remote repositories hosted on another JFrog Artifactory instance.

      Example: https://artifactory.mycompany.com/artifactory/my-repo

    • Custom: For VCS providers not listed. Provide the URL and credentials manually.

      Note

      The VCS repository feature, including the Custom provider, currently only supports a two-level path structure (e.g., organization/repository). Nested repository paths common in GitLab (e.g., group/subgroup/repository) are not supported.

      art-package-vcs-settings-15-09.png

  5. Click Create Remote Repository.