NOTE: NOT QUITE READY FOR PUBLIC USE

TODO

• add setup and teardown keys
• support shells other than bash
• update the readme with smooth as butter instructions
• choose a license

steakpie

A really simple CD server.

It listens for webhooks from Githubs registry.packages webhook, and when it receives one for a configured repository, that has ab image tag of latest it runs the commands that you've specified.

No abstractions, no elaborate interfaces. A single binary, a single basic config file and you're off.

Initially designed to work with docker and docker-compose but in theory you can do whatever you want. The only current limitation is that it only listens for Registry packages webhook payloads.

Quick start

1. Create a webhook on a repository you want to have deployed when a package is updated.
2. Download the binary to your server. `wget https://github.com/treejamie/steakpie/releases/download/v0.0.4/steakpie-0.0.4-arm64§
3. Maybe link it becasue your OCD won't let you run a binary with a messy name - ln -s steakpie-0.0.4-arm64 steakpie
4. Make it executable chmod +x steakpie-0.0.4-arm64
5. Make sure you've got $WEBHOOK_SECRET in your environment and if you want to run on a port other than 3142, then set $PORT
6. Make a config file called config.yml or config.yaml

# name of your github repo
jamiec:  name of repo
  run:  # domain language - consider it a static string.
    /foo/bar:  # this is the directory you want to cd'into to run the below commands.
      - - echo "yay" # a command
        - echo "nested" # a nested command
      - cat foo.txt # a parallel command
    /another/dir:  # cd into another dir to do some other stuff
      - ls -al # another command

You get to control what commands run and in what dirs. No more see-sawing with npm commands and setting root directorys, just do the thing.

Finally, you're going to have to expose this to the internet somehow. I like cloudflare tunnels as it saves me poking holes in my firewalls, but if you're fine with that then you want to open up port 3142.

Why?

I was building a docker image as a build step when code was merged into main. I wanted to pull the latest image.

Alternatives

Coolify

Great, loads of options, but it was overkill. I just wanted to have my raspberry pi pull the latest version of an image when it was updated. I didn't want to lose a load of resource to running the central coolify platform on my pi, so I tried the cloud. $5 is a steal, but I was scratching my head on how to get it to work and I kept hitting errors deploying things.

Disco

Loved the idea, couldn't install it. Even with a fresh Ubuntu 24.04 I repeatedly failed. Aborted.

K38's.

Life is too short for that much yaml.

Manually updating.

No.

Cron

You got me. There's no reason you couldn't use a crontab and shell script to do this periodically and you'd get free email support if your machine had that configured.

However, that would have been a lousy project.

Running

I like doppler for secret management, but you're free to do whatever you want with your environmental variables.

Prerequisites

Set the required environment variable:

export WEBHOOK_SECRET=your-github-webhook-secret

Start the server

./steakpie

The server will start on port 3142 by default but you can put it on whatever port you want.

Custom port

PORT=3142 ./steakpie

Full Example

WEBHOOK_SECRET=my-secret-key ./steakpie

Building

You devil you..

go build -o steakpie ./cmd/steakpie