Installation¶
pgway is not released yet. There are no versioned GitHub Releases or installers today.
Upcoming releases
Multi-platform binaries will be published later with GoReleaser (see issue #19: linux/darwin/windows, amd64/arm64, for pgway, pgway-cp, pgway-dp, and pgctl). Until then, run from source.
For now: clone the repository and use go build, make build, or go run.
Prerequisites¶
- Go 1.25 or newer (
go version) - Git
- Optional, only for dashboard development: Bun or Node.js 20+ (not required for the gateway itself)
Clone¶
git clone https://github.com/aknEvrnky/pgway.git
cd pgway
Build all binaries¶
make build
This writes four binaries under ./build/:
| Binary | Path |
|---|---|
| All-in-one | ./build/pgway |
| Control Plane | ./build/pgway-cp |
| Data Plane | ./build/pgway-dp |
| CLI | ./build/pgctl |
Build a single binary¶
go build -o pgway ./cmd/pgway
go build -o pgway-cp ./cmd/pgway-cp
go build -o pgway-dp ./cmd/pgway-dp
go build -o pgctl ./cmd/pgctl
Run without installing¶
Useful for a quick smoke test from the repo root (still needs a config file — covered in the next Getting Started pages):
go run ./cmd/pgway
go run ./cmd/pgctl --help
Or run a binary you just built:
./build/pgway
./build/pgctl --help
go install (optional)¶
You can install module tip into your GOBIN / GOPATH/bin:
go install github.com/aknEvrnky/pgway/cmd/pgway@latest
go install github.com/aknEvrnky/pgway/cmd/pgway-cp@latest
go install github.com/aknEvrnky/pgway/cmd/pgway-dp@latest
go install github.com/aknEvrnky/pgway/cmd/pgctl@latest
Note
@latest tracks the default branch tip, not a semver release. Prefer cloning and make build when you want a known local checkout.
What’s next¶
Configuration — config file location, keys, and examples for each binary. Then: bootstrap admin + minimal stack.