https://github.com/debitoor/ssh-private-key-buildpack

SSH private key configuration
https://github.com/debitoor/ssh-private-key-buildpack

Last synced: 3 days ago
JSON representation

SSH private key configuration

• Host: GitHub
• URL: https://github.com/debitoor/ssh-private-key-buildpack
• Owner: debitoor
• Created: 2015-05-19T12:42:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-07-04T17:36:21.000Z (over 5 years ago)
• Last Synced: 2024-08-02T12:50:40.410Z (3 months ago)
• Language: Shell
• Size: 9.77 KB
• Stars: 55
• Watchers: 33
• Forks: 107
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - debitoor/ssh-private-key-buildpack - SSH private key configuration (others)

README

        
# ssh-private-key-buildpack

A Heroku buildpack for setting the ssh private key as part of the application build. It's meant to be used as part of a setup [using multiple buildpacks](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app), so other buildpacks can authenticate with hosts using ssh keys, for instance to install dependencies from private git repositories.

# Example usage

## Configure Multiple Buildpacks

### _Option 1:_ Heroku CLI or Dashboard

Add the buildpack to your Heroku app either using the CLI or the Heroku dashboard. The `ssh-private-key-buildpack` needs to run before any buildpack trying to get ssh access. In the following example, it runs before the `heroku/go` buildpack.

    $ heroku buildpacks:set --index 1 https://github.com/debitoor/ssh-private-key-buildpack.git

    $ heroku buildpacks:add heroku/go

### _Option 2:_ Use `heroku-buildpack-multi`

Instead of setting the buildpacks directly with Heroku they can also be configured using a `.buildpacks` in combination with [`heroku-buildpack-multi`]( https://github.com/heroku/heroku-buildpack-multi).

    $ heroku buildpacks:set https://github.com/heroku/heroku-buildpack-multi.git  

The same example given for the CLI use would have the following `.buildpacks` file.

    $ cat .buildpacks

    https://github.com/debitoor/ssh-private-key-buildpack.git

    https://github.com/heroku/heroku-buildpack-go

## Configure SSH Key

Set the private key environment variable `SSH_KEY` of your Heroku app (note that the key needs to be base64 encoded).

    $ heroku config:set SSH_KEY=$(cat path/to/your/keys/id_rsa | base64)

By default the buildback adds Github to `known_hosts`. However you can configure your app to allow custom hosts, too. All that's needed is the set `SSH_HOSTS` for you app to a comma-separated list of hosts, e.g. `[email protected],example.com`

    $ heroku config:set SSH_HOSTS="[email protected],example.com"