Installing on a single machine

This page describes how to install a Piped on a single machine.


Having piped’s ID and Key strings
  • Ensure that the piped has been registered and you are having its PIPED_ID and PIPED_KEY strings.
  • If you are not having them, this page guides you how to register a new one.
Preparing SSH key
  • If your Git repositories are private, piped requires a private SSH key to access those repositories.
  • Please checkout this documentation for how to generate a new SSH key pair. Then add the public key to your repositories. (If you are using GitHub, you can add it to Deploy Keys at the repository’s Settings page.)


  • Downloading the latest piped binary for your machine

  • Preparing a piped configuration file as the following:

    kind: Piped
      projectID: {PROJECT_ID}
      pipedID: {PIPED_ID}
      pipedKeyFile: {PATH_TO_PIPED_KEY_FILE}
      # Write in a format like "host:443" because the communication is done via gRPC.
        sshKeyFile: {PATH_TO_SSH_KEY_FILE}
        - repoId: {REPO_ID_OR_NAME}
          branch: {GIT_BRANCH}
      syncInterval: 1m

See ConfigurationReference for the full configuration.

  • Start running the piped

    ./piped piped --config-file={PATH_TO_PIPED_CONFIG_FILE}

Last modified July 4, 2024: Release v0.48.0 (#5023) (6439f977)