Skip to content
This repository has been archived by the owner on Aug 22, 2024. It is now read-only.

Latest commit

 

History

History
75 lines (51 loc) · 1.92 KB

README.md

File metadata and controls

75 lines (51 loc) · 1.92 KB
Raw

heroku-buildpack-spiped

spiped provides symmetrically encrypted and authenticated pipes over TCP between socket addresses. Essentially, it allows you to tunnel insecure protocols to a target over an encrypt and authenticated socket.

Common uses include:

Thanks

The development and continued support for this buildpack is sponsored by Dead Man's Snitch.

Ever been surprised that a critical cron job or scheduled task was silently failing to run? Whether it's backups, cache clearing, or sending invoices, Dead Man's Snitch makes it easy to monitor heroku scheduler tasks or cron jobs to give you the confidence they're running when and how they should.

Get started for free today with Dead Man's Snitch on Heroku

Install

heroku buildpacks:add https://github.com/deadmanssnitch/heroku-buildpack-spiped
git push heroku master

Creating a key

dd if=/dev/urandom bs=32 count=1 status=none of=key
heroku config:set SPIPED_KEY="$(base64 -w0 key)"

Usage

Configuration

SPIPED_ENABLED

Set to true to automatically enable an spiped connection based on

heroku config:set SPIPED_ENABLED=true

SPIPED_KEY

Base64 encoded encryption key.

heroku config:set SPIPED_KEY="$(base64 -w0 key)"

SPIPED_TARGET

Address to which spiped should connect. Must be in one of the following formats:

  • /absolute/path/to/unix/socket
  • host.name:port
  • [ip.v4.ad.dr]:port
  • [ipv6::addr]:port

SPIPED_SOURCE

Address on which spiped should listen for incoming connections.

  • /absolute/path/to/unix/socket
  • host.name:port
  • [ip.v4.ad.dr]:port
  • [ipv6::addr]:port