Skip to main content

Active SSH Private Key

This step sets up your SSH key in the build machine if you used one to connect your repository. This allows the build machine to connect to your private repository using your SSH key.

Prerequisites

There are no prerequisites required before using the Active SSH Private Key step.

caution

If you connect to your repository via SSH, use this step before the Git Clone step. To securely clone repositories connected via SSH, you must define the SSH key for the relevant build agent.

Screenshot

Input Variables

This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s).

Screenshot
Variable NameDescriptionStatus
$AC_REPOSITORY_SSH_KEYSSH private key in RSA format. This value defaults to $AC_REPOSITORY_SSH_KEY. It is automatically defined as the Reserved Environment Variables when an SSH connection is made.Optional

Output Variables

The output(s) resulting from the operation of this component are as follows:

Variable NameDescription
SSH_AUTH_SOCKThis is the path to the SSH Auth Socket.

To access the source code of this component, please use the following link:

Preview of GitHub - appcircleio/appcircle-activate-ssh-key-component