Getting Started
Installation
Requirements
- Go 1.25 or later
go install
go install github.com/majorcontext/gatekeeper/cmd/gatekeeper@latest
This places the gatekeeper binary in $GOPATH/bin.
Build from source
git clone https://github.com/majorcontext/gatekeeper.git
cd gatekeeper
go build -o gatekeeper ./cmd/gatekeeper/
Set the version at build time with linker flags:
go build -ldflags "-X main.version=v0.10.0" -o gatekeeper ./cmd/gatekeeper/
Docker
docker pull ghcr.io/majorcontext/gatekeeper:latest
Run with a config file mounted:
docker run --rm -v ./gatekeeper.yaml:/etc/gatekeeper/gatekeeper.yaml \
ghcr.io/majorcontext/gatekeeper --config /etc/gatekeeper/gatekeeper.yaml
Verify
gatekeeper --config /dev/null
The binary starts and exits with a config error, confirming it is installed correctly.