Documentation


Doc index page

Install private Composer dependencies

SymfonyInsight relies on Composer to install your project dependencies, meaning it will use Composer authentication features to access your private dependencies. More specifically, SymfonyInsight will use your dedicated SSH private key generated by SymfonyConnect.

The aim of this document is to authorize SymfonyInsight to access your private dependencies on the different platforms supported.

Analyze GitHub projects with private dependencies

The SSH key used to analyze the source code of private GitHub projects is called the deploy key. When your project also relies on private dependencies, this deploy key is not enough to install them. In that case you need to setup a new SSH key on GitHub website.

  1. Click on this link to access to the SSH section of your SymfonyConnect account, which is the authentication service used by SymfonyInsight.
  2. If the Manage your private SSH key section displays a key, copy its contents. Otherwise, click the Generate button to create your SSH key and copy its contents.
  3. Access to your GitHub account SSH settings. Click on the New SSH key button, and paste the key copied in the previous step. Give the key a meaningful name (e.g. SymfonyInsight) and click the Add SSH key button to save the changes.
  4. Return to SymfonyInsight and run a new analysis for your private project.

Analyze GitLab projects with private dependencies

The SSH key used to create your project should be enough for SymfonyInsight to access your private dependencies. If your have an authentication error, check that the account linked to the SSH private key is allowed to access the dependencies.

How to analyze Bitbucket projects with private dependencies

The SSH key used to analyze the source code of private Bitbucket projects is called the deploy key. When your project also relies on private dependencies, this deploy key is not enough to install them. In that case you need to setup a new SSH key on Bitbucket website.

  1. Click on this link to access to the SSH section of your SymfonyConnect account, which is the authentication service used by SymfonyInsight.
  2. If the Manage your private SSH key section displays a key, copy its contents. Otherwise, click the Generate button to create your SSH key and copy its contents.

  3. Access to your Bitbucket account settings, go to the SSH Keys section and click on the Add key button.

    Paste the key copied in the previous step and give it a meaningful name (e.g. SymfonyInsight). Click the Add key button to save the changes.

  4. Return to SymfonyInsight and run a new analysis for your private project.

Analyze projects hosted on another platform with private dependencies

The simplest way to give access to SymfonyInsight to your private dependencies when using the push mode for projects not accessible by SymfonyInsight is to include your dependencies in the Git repository of SymfonyInsight.