Add a new Git Repository source

Portainer's Git deployment functionality does not currently support the use of Git submodules. If your repository includes submodules, they will not be pulled as part of the deployment. We hope to add support for submodules in a future release.

Symlinks within a Git repository are not supported. Repositories containing symlinks will not be deployed successfully.

To add a new source from a Git Repository (GitHub, GitLab, Bitbucket, etc.), select Sources in the left hand menu, select Add new at the top right of the page, and select Git Repository. Select Continue and fill in the form using the details below as a guide.

As you enter your details, your connection will be checked and reported at the bottom of the form.

Source Name	Give your source a descriptive name.
Repository URL	Enter the URL to your Git repository.
Skip TLS Verification	Enable this option to skip verification of your Git repository's TLS certificate.
Authentication	Enable this if your Git repository requires authentication.
Git provider	Select your Git provider from the drop down menu, the authentication details will change based on your selection.
Authorization type	When providing details for a Custom Git Provider, select if you would like to authorize with a password (Basic), or an Access Token (Token).
Username	Enter your Git username.
Personal Access Token / Password	When Authentication is enabled, enter your personal access token or password. Ensure your token has repository read permissions, see the Git authentication token permissions FAQ for details.

Select Continue when you have completed your details and have a successful connection.

Finally, configure who can use the source or edit the source's connection details. Choose one of the following access levels:

• Administrators: Only admin users can edit and use the source.

• Restricted: Specify any Authorized users and Authorized teams permitted to edit and use the source. Only these users and teams - plus admins - will have access.

• Public: Any user with access to this environment can edit and use the source.

Select Create to save your source.