Skip to content

Commit 7b4eda6

Browse files
authored
docs: expand top-level README (#8)
1 parent 5de7bf0 commit 7b4eda6

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# ohttp-tools
2-
OHTTP gateway server image and tooling (load tests, probes) shared across services.
2+
3+
Tooling and container images for running [Oblivious HTTP (RFC 9458)](https://www.rfc-editor.org/rfc/rfc9458.html)
4+
gateways. Currently used by World ID; structured to be reusable for any service
5+
that adopts OHTTP.
6+
7+
## Contents
8+
9+
- [`ohttp-probe/`](./ohttp-probe) — Go CLI for probing and load-testing OHTTP
10+
gateways. See [`ohttp-probe/README.md`](./ohttp-probe/README.md) for usage.
11+
- `.github/workflows/build-ohttp-gateway.yml` — repackages
12+
[`cloudflare/privacy-gateway-server-go`](https://github.com/cloudflare/privacy-gateway-server-go)
13+
at a pinned version into an org-published image.
14+
- `.github/workflows/build-ohttp-probe.yml` — builds and publishes the probe
15+
image from this repo.
16+
17+
## Published images
18+
19+
Both images are public on GHCR (anonymous pull works):
20+
21+
| Image | Source | Tags |
22+
|---|---|---|
23+
| `ghcr.io/worldcoin/ohttp-tools/ohttp-gateway` | `cloudflare/privacy-gateway-server-go` (pinned via `VERSION` in the build workflow) | `latest`, `<version>` (e.g. `v0.0.3`) |
24+
| `ghcr.io/worldcoin/ohttp-tools/ohttp-probe` | this repo, `ohttp-probe/Dockerfile` | `sha-<full-sha>` |
25+
26+
Both images are `linux/amd64` only.
27+
28+
To bump the gateway version, edit `VERSION` in
29+
`.github/workflows/build-ohttp-gateway.yml` and merge — the workflow rebuilds
30+
on `main`.
31+
32+
## Local development
33+
34+
The probe is a self-contained Go module — see
35+
[`ohttp-probe/README.md`](./ohttp-probe/README.md) for build and command
36+
reference.

0 commit comments

Comments
 (0)