propel

tool for triggering pre-defined actions on a remote system

what is it?

A utility that exposes webhooks that can be used to run a predetermined command on the local system.

Use propel as part of your remote management system. It can be particularly useful for ad hoc management tasks and deployment processes.

quick start

Install with:

curl -fsSL https://raw.githubusercontent.com/aae42/propel/main/install.sh | bash

or

Build the executable with go build. Requires Go 1.21.

Set up a propel_config.yaml that looks like this:

---
port: 42424
endpoints:
  f4883ed8-070c-4acc-9e1e-c67c2e3d471d:
    start_in: .
    command: whoami
  881ce173-b02c-4bb5-b1a3-233bae46723a:
    start_in: .
    command: ls -la

Provide any endpoints you want (i have randomly generated UUIDs in the example), along with the start directory and the commands to run.

Run propel, it will start an http server on the port, and you can POST to those endpoints to run the commands:

curl -X POST http://localhost:42424/881ce173-b02c-4bb5-b1a3-233bae46723a

results in ls -la being run in the working directory propel was run from.

frequently asked questions

Q: What kind of stuff can I run with this?

A: Whatever you want

Q: What kind of stuff should I run with this?

A: Deployment tools/scripts, something as simple as git pull or as complex as cinc-client

Q: Why not use SSH?

A: 🤷, this seems simpler