Welcome to the Gofer documentation! This documentation is a reference for all available features and options of Gofer.
- To kick the tires visit: Getting Started
- To read more about Gofer's Feature set visit: Features
- To understand the why of Gofer visit: Philosophy
Gofer: Run short-lived jobs easily.
Gofer is an opinionated, streamlined automation engine designed for the cloud-native era. It specializes in executing your custom scripts in a containerized environment, making it versatile for both developers and operations teams. Deploy Gofer effortlessly as a single static binary, and manage it using expressive, declarative configurations written in real programming languages. Once set up, Gofer takes care of scheduling and running your automation tasks—be it on Nomad, Kubernetes, or even Local Docker.
Its primary function is to execute short-term jobs like code linting, build automation, testing, port scanning, ETL operations, or any task you can containerize and trigger based on events.
- Simple Deployment: Install Gofer effortlessly with a single static binary and manage it through its intuitive command-line interface.
- Language Flexibility: Craft your pipelines in programming languages you're already comfortable with, such as Go or Rust—no more wrestling with unfamiliar YAML.
- Local Testing: Validate and run your pipelines locally, eliminating the guesswork of "commit and see" testing.
- Extensible Architecture: Easily extend Gofer's capabilities by writing your own plugins, backends, and more, in any language via gRPC.
- Built-In Storage: Comes with an integrated Object and Secret store for your convenience.
- DAG Support: Harness the power of Directed Acyclic Graphs (DAGs) for complex workflow automation.
- Robust Reliability: Automatic versioning, Blue/Green deployments, and canary releases ensure the stability and dependability of your pipelines.
If you want to fully dive into Gofer, check out the documentation site!
Extended installation information is available through the documentation site.
You'll need to install protoc and its associated golang/grpc modules first
git clone https://github.com/clintjedwards/gofer && cd gofer
make build OUTPUT=/tmp/gofer
The Gofer binary comes with a CLI to manage the server as well as act as a client.
Gofer is setup such that the base run mode is the development mode. So simply running the binary without any additional flags allows easy authless development.
To run Gofer dev mode:
To build protocol buffers:
Gofer uses flags, env vars, and files to manage configuration (in order of most important). The Makefile already includes all the commands and flags you need to run in dev mode by simply running
In case you want to run without the make file simply run:
export GOFER_LOG_LEVEL=debug go build -o /tmp/$gofer /tmp/gofer service start --dev-mode
Gofer uses grpc and protobufs to communicate with both plugins and provide an external API. These protobuf
files are located in
/proto. To compile new protobufs once the original
.proto files have changed you can use the
make build-protos command.
Documentation is done with mdbook.
cargo install mdbook cargo install mdbook-linkcheck
Once you have mdbook you can simply run
make run-docs to give you an auto-reloading dev version of the documentation in a browser.
The Gif on the README page uses vhs; a very handy tool that allows you to write a configuration file which will pop out a gif on the other side.
In order to do this VHS has to run the commands so we must start the server first before we regenerate the gif.
rm -rf /tmp/gofer* # Start with a fresh database make run # Start the server in dev mode cd documentation/src/assets vhs < demo.tape # this will start running commands against the server and output the gif as demo.gif.
- Clint Edwards - Github
This software is provided as-is. It's a hobby project, done in my free time, and I don't get paid for doing it.