Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ data/
/.cache/
telemetry.test
bin/
fanout
pitot
ui/host/dist/

# Dev files
Expand Down
282 changes: 141 additions & 141 deletions .env.example

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug report
description: Report a reproducible problem in Fanout OSS
description: Report a reproducible problem in Pitot OSS
title: "bug: "
labels: [bug]
body:
Expand All @@ -9,7 +9,7 @@ body:
- type: input
id: version
attributes:
label: Fanout version
label: Pitot version
description: Release tag, image digest, or commit SHA.
validations:
required: true
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Setup and deployment questions
url: https://github.com/labstack/fanout/discussions
url: https://github.com/labstack/pitot/discussions
about: Ask the community before filing a product defect.
- name: Security vulnerability
url: https://github.com/labstack/fanout/security/advisories/new
url: https://github.com/labstack/pitot/security/advisories/new
about: Report vulnerabilities privately; never put secrets in an issue.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feature request
description: Propose a broadly useful Fanout OSS improvement
description: Propose a broadly useful Pitot OSS improvement
title: "feat: "
labels: [enhancement]
body:
Expand All @@ -14,7 +14,7 @@ body:
id: users
attributes:
label: Who benefits?
description: Explain why this is useful to typical self-hosted Fanout users.
description: Explain why this is useful to typical self-hosted Pitot users.
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## What changed

<!-- Describe the user-visible outcome and why it belongs in Fanout OSS. -->
<!-- Describe the user-visible outcome and why it belongs in Pitot OSS. -->

## Verification

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ jobs:
if: matrix.slug != 'catalog'
run: just e2e ${{ matrix.args }}
env:
FANOUT_E2E_SKIP_PERFORMANCE: ${{ matrix.skip_performance }}
PITOT_E2E_SKIP_PERFORMANCE: ${{ matrix.skip_performance }}
- name: Upload browser evidence
if: always()
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
Expand Down Expand Up @@ -292,14 +292,14 @@ jobs:
context: .
load: true
push: false
tags: fanout:ci
tags: pitot:ci
build-args: VERSION=sha-${{ github.event.pull_request.head.sha || github.sha }}
cache-from: type=gha
cache-to: type=gha,mode=max
- name: Scan the runtime image
uses: aquasecurity/trivy-action@a9c7b0f06e461e9d4b4d1711f154ee024b8d7ab8 # v0.36.0
with:
image-ref: fanout:ci
image-ref: pitot:ci
version: v0.74.0
scanners: vuln,secret
severity: HIGH,CRITICAL
Expand All @@ -323,7 +323,7 @@ jobs:
id: meta
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
with:
images: ghcr.io/labstack/fanout
images: ghcr.io/labstack/pitot
tags: |
type=ref,event=branch
type=sha,prefix=sha-
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
path-to-document: https://github.com/labstack/fanout/blob/main/CLA.md
path-to-document: https://github.com/labstack/pitot/blob/main/CLA.md
path-to-signatures: signatures.json
# Signatures live on their own branch. Storing them on main would put
# a bot commit into the release history and trigger a CI run plus an
Expand Down
44 changes: 22 additions & 22 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ permissions:
contents: read

env:
IMAGE: ghcr.io/labstack/fanout
DOCKERHUB_IMAGE: docker.io/labstack/fanout
IMAGE: ghcr.io/labstack/pitot
DOCKERHUB_IMAGE: docker.io/labstack/pitot
MCP_PUBLISHER_VERSION: "1.8.1"
MCP_PUBLISHER_LINUX_AMD64_SHA256: "a06c9096dcb9727c13555b6be26c7effa707b01f06a4c561ba7a3635443cf2cc"

Expand Down Expand Up @@ -149,20 +149,20 @@ jobs:
version="${GITHUB_REF_NAME}"
bash scripts/with-duckdb.sh go test ./internal/engine -run 'TestPinnedEngine|TestSQLBoundary' -count=1
mkdir -p stage
bash scripts/with-duckdb.sh go build -trimpath -ldflags "-s -w -X main.version=${version}" -o stage/fanout ./cmd/fanout
bash scripts/with-duckdb.sh go build -trimpath -ldflags "-s -w -X main.version=${version}" -o stage/pitot ./cmd/pitot
for doc in LICENSE NOTICE README.md THIRD_PARTY_NOTICES TRADEMARK.md; do
if [ -f "${doc}" ]; then cp "${doc}" stage/; fi
done
tar -czf "fanout_${version}_${{ matrix.goos }}_${{ matrix.goarch }}.tar.gz" -C stage .
tar -czf "pitot_${version}_${{ matrix.goos }}_${{ matrix.goarch }}.tar.gz" -C stage .
- name: Smoke test the binary
run: |
set -euo pipefail
got="$(./stage/fanout -version)"
got="$(./stage/pitot -version)"
[ "${got}" = "${GITHUB_REF_NAME}" ] || { echo "version = ${got}, want ${GITHUB_REF_NAME}"; exit 1; }
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: fanout_${{ matrix.goos }}_${{ matrix.goarch }}
path: fanout_*.tar.gz
name: pitot_${{ matrix.goos }}_${{ matrix.goarch }}
path: pitot_*.tar.gz
if-no-files-found: error

# Each image layer is built natively and the two are joined into one manifest,
Expand Down Expand Up @@ -326,7 +326,7 @@ jobs:
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
path: artifacts
pattern: fanout_*
pattern: pitot_*
merge-multiple: true
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
Expand All @@ -336,8 +336,8 @@ jobs:
run: |
set -euo pipefail
cd artifacts
ls -1 fanout_*.tar.gz
sha256sum fanout_*.tar.gz > SHA256SUMS
ls -1 pitot_*.tar.gz
sha256sum pitot_*.tar.gz > SHA256SUMS
cat SHA256SUMS
- name: Attest archives and checksum manifest
uses: actions/attest-build-provenance@4d101475d8b20a2381f78447822ac1eab6504dd8 # v4.2.2
Expand All @@ -356,7 +356,7 @@ jobs:
--notes "$(cat notes/upgrade-notes.md)" \
--generate-notes \
--verify-tag \
artifacts/fanout_*.tar.gz artifacts/SHA256SUMS
artifacts/pitot_*.tar.gz artifacts/SHA256SUMS

verify-release:
name: verify public release
Expand All @@ -373,13 +373,13 @@ jobs:
tmp="$(mktemp -d)"
trap 'rm -rf "${tmp}"' EXIT
cd "${tmp}"
base="https://github.com/labstack/fanout/releases/download/${VERSION}"
base="https://github.com/labstack/pitot/releases/download/${VERSION}"
curl -fsSLO "${base}/SHA256SUMS"
for target in linux_amd64 linux_arm64 darwin_amd64 darwin_arm64; do
curl -fsSLO "${base}/fanout_${VERSION}_${target}.tar.gz"
curl -fsSLO "${base}/pitot_${VERSION}_${target}.tar.gz"
done
sha256sum -c SHA256SUMS
for archive in fanout_*.tar.gz; do
for archive in pitot_*.tar.gz; do
listing="${archive}.contents"
tar -tzf "${archive}" > "${listing}"
for document in LICENSE NOTICE README.md THIRD_PARTY_NOTICES TRADEMARK.md; do
Expand All @@ -390,18 +390,18 @@ jobs:
done
done
mkdir native
tar -xzf "fanout_${VERSION}_linux_amd64.tar.gz" -C native ./fanout
[ "$(native/fanout -version)" = "${VERSION}" ]
tar -xzf "pitot_${VERSION}_linux_amd64.tar.gz" -C native ./pitot
[ "$(native/pitot -version)" = "${VERSION}" ]
- name: Verify the public installer
env:
VERSION: ${{ github.ref_name }}
run: |
set -euo pipefail
tmp="$(mktemp -d)"
trap 'rm -rf "${tmp}"' EXIT
curl -fsSL "https://raw.githubusercontent.com/labstack/fanout/${VERSION}/scripts/install.sh" -o "${tmp}/install.sh"
FANOUT_VERSION="${VERSION}" FANOUT_PREFIX="${tmp}/bin" sh "${tmp}/install.sh"
[ "$("${tmp}/bin/fanout" -version)" = "${VERSION}" ]
curl -fsSL "https://raw.githubusercontent.com/labstack/pitot/${VERSION}/scripts/install.sh" -o "${tmp}/install.sh"
PITOT_VERSION="${VERSION}" PITOT_PREFIX="${tmp}/bin" sh "${tmp}/install.sh"
[ "$("${tmp}/bin/pitot" -version)" = "${VERSION}" ]
- name: Verify GitHub build provenance
env:
GH_TOKEN: ${{ github.token }}
Expand All @@ -411,11 +411,11 @@ jobs:
tmp="$(mktemp -d)"
trap 'rm -rf "${tmp}"' EXIT
cd "${tmp}"
base="https://github.com/labstack/fanout/releases/download/${VERSION}"
base="https://github.com/labstack/pitot/releases/download/${VERSION}"
for target in linux_amd64 linux_arm64 darwin_amd64 darwin_arm64; do
archive="fanout_${VERSION}_${target}.tar.gz"
archive="pitot_${VERSION}_${target}.tar.gz"
curl -fsSLO "${base}/${archive}"
gh attestation verify "${archive}" --repo labstack/fanout
gh attestation verify "${archive}" --repo labstack/pitot
done

mcp-registry:
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ on:
# regenerated page is a documentation change whether or not anything under
# site/ was touched by hand: settings come from internal/config, alert
# variables from internal/alert, the roles matrix and route table from
# internal/api plus internal/agent and cmd/fanout, and the MCP tools from
# internal/api plus internal/agent and cmd/pitot, and the MCP tools from
# internal/mcp.
paths:
- "site/**"
Expand All @@ -30,8 +30,8 @@ on:
- "internal/api/**"
- "internal/agent/**"
- "internal/mcp/**"
- "cmd/fanout/**"
- "cmd/fanout-docgen/**"
- "cmd/pitot/**"
- "cmd/pitot-docgen/**"
- "internal/duckdb/**"
- "scripts/with-duckdb.sh"
- "scripts/go-build-tags.sh"
Expand Down Expand Up @@ -82,7 +82,7 @@ jobs:
- name: Refuse a reference that is behind the code
env:
CGO_ENABLED: "1"
run: bash scripts/with-duckdb.sh go run ./cmd/fanout-docgen --check
run: bash scripts/with-duckdb.sh go run ./cmd/pitot-docgen --check

- name: Install dependencies
working-directory: site
Expand All @@ -95,7 +95,7 @@ jobs:
- name: Build
working-directory: site
env:
SITE_URL: https://fanout.run
SITE_URL: https://pitot.dev
# A GA4 measurement id is public in the delivered page, so this is a
# repository variable rather than a secret. When absent, the site
# build emits no analytics script or request.
Expand All @@ -117,6 +117,6 @@ jobs:
CLOUDFLARE_ACCOUNT_ID: e6379d37f788129207ab5f566abfb4ff
run: |
npx --yes wrangler@4.123.0 pages deploy dist \
--project-name fanout \
--project-name pitot \
--branch main \
--commit-hash "${GITHUB_SHA}"
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ cover.out

# Ad-hoc output from `go build` without -o (named after the package).
/bench
/fanout
/fanout-docgen
/pitot
/pitot-docgen
.wrangler/
4 changes: 2 additions & 2 deletions .gitleaks.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ regex = '''(/Users|/home)/[A-Za-z0-9_.-]+/'''
keywords = ["/users/", "/home/"]

[[rules]]
id = "fanout-bearer-secret"
description = "Fanout opaque bearer secret"
id = "pitot-bearer-secret"
description = "Pitot opaque bearer secret"
regex = '''fo[iacr]_[A-Za-z0-9_-]{43}\b'''
keywords = ["foi_", "foa_", "for_", "foc_"]
16 changes: 10 additions & 6 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@

- Configuration is environment-only. `internal/config/config.go` is the
authoritative schema: built-in defaults, then nonempty process environment.
Custom names use `FANOUT_` plus a clear name, adding the area only when it
Custom names use `PITOT_` plus a clear name, adding the area only when it
clarifies; vendor credentials and endpoints keep `ANTHROPIC_API_KEY`,
`ANTHROPIC_BASE_URL`, `OPENAI_API_KEY`, and `OPENAI_BASE_URL`.
Provider and model selection remain `FANOUT_AI_PROVIDER` and `FANOUT_AI_MODEL`.
Provider and model selection remain `PITOT_AI_PROVIDER` and `PITOT_AI_MODEL`.
An empty provider disables chat; exactly `anthropic` or `openai` requires
that provider's key. Ignore AI credentials and endpoints when chat is disabled;
validate only the selected provider's endpoint.
- For the first Pitot alpha, `internal/config/loader.go` resolves legacy
`FANOUT_*` only when the equivalent primary name is unset. Preserve explicit
empty primaries and emit one names-only warning. See `CHANGELOG.md` for the
removal window and storage compatibility names.
- Every `secret:"true"` field accepts `<ENV>_FILE`. Both forms nonempty fail;
secret files lose exactly one trailing LF or CRLF and must remain nonempty.
Unselected AI providers' value and file forms are ignored.
Expand All @@ -23,10 +27,10 @@
- The binary does not load dotenv. `just run` uses Node's native `parseEnv` for
optional ignored `./.env`, then inherited environment values win. Personal
development credentials may live there. Never shell-source dotenv. Only
Fanout's namespace rejects unknown names; tolerate platform service variables
Pitot's namespace rejects unknown names; tolerate platform service variables
and ignore unrelated names in shared vendor namespaces.
- Native listener default is `127.0.0.1:7520`. The image supplies
`FANOUT_ADDR=:7520` and `FANOUT_DATA_DIR=/var/lib/fanout/data`.
`PITOT_ADDR=:7520` and `PITOT_DATA_DIR=/var/lib/pitot/data`.
- Repository-managed secret profiles adopt SOPS authority through a verified
migration, with key recovery in 1Password. Existing vault/platform delivery
remains authoritative until all consumers and recovery are verified. Follow
Expand Down Expand Up @@ -127,7 +131,7 @@

## Product versioning

Fanout uses CalVer with the format `YYYY.M.N[-alpha|-beta|-rc]`.
Pitot uses CalVer with the format `YYYY.M.N[-alpha|-beta|-rc]`.

- `YYYY` is the full year and `M` is the unpadded month.
- `N` is the release number within that month, starting at `0`.
Expand Down Expand Up @@ -177,7 +181,7 @@ resources and protocol-defined contracts keep their own semantics.
`/api/auth/code/verify`, and `POST /api/auth/logout`. Flow selection, passkeys,
account linking, and sign-in link verification are distinct operations.
OIDC sign-in uses `/api/auth/oidc/start` and `/api/auth/oidc/callback` without
a provider segment because Fanout supports exactly one configured provider.
a provider segment because Pitot supports exactly one configured provider.
- Operational routes use `/healthz` for liveness, `/readyz` for readiness,
and `/metrics` for Prometheus exposition. Preserve authorization requirements.
- MCP tool names use verb-first snake_case and describe their behavior:
Expand Down
40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Changelog

## Unreleased — Pitot rename (2026-11-11)

The product is now **Pitot** (pronounced **PEE-toh**), formerly Fanout, at
[pitot.dev](https://pitot.dev). The owner approved this rename on 2026-11-11 to avoid a
conflict with a third party's registered US trademark in cloud services.

- The Go module is `github.com/labstack/pitot`; the binary is `pitot` and native
archives are `pitot_<version>_<os>_<arch>.tar.gz`, containing `./pitot`.
- Container images are `ghcr.io/labstack/pitot` and `docker.io/labstack/pitot`.
Update deployment manifests, service names, install URLs and MCP client entries.
The MCP Registry identity is `io.github.labstack/pitot`.
- Use `PITOT_*` settings. For the first Pitot alpha only, an unset primary
variable falls back to its `FANOUT_*` equivalent, including secret `_FILE`
forms and installer version/prefix overrides. A primary variable explicitly
set to empty blocks its legacy equivalent and uses the ordinary default.
Startup emits one deprecation warning listing used old names, never values.
Mixed value/file forms still fail when both are nonempty. Replace old names
before upgrading to the following alpha, when this bridge is due for removal.
- Keep the complete existing data directory. Native default `./data`, the
`control/fanout.sqlite` filename, all other storage filenames, telemetry format,
marker files, Parquet `fanout.spill.*` footer keys, stored
`_fanout_diagnostic_context` metadata and published migrations are unchanged; there is no data migration.
The new image defaults to `/var/lib/pitot/data`: mount the **existing** volume
there, or explicitly set `PITOT_DATA_DIR` to its existing mount location.
Do not accidentally create a fresh named volume when changing deployment names.
- Existing sessions keep their cookie names and keyboard preferences keep their
storage key. Saved chat activities resolve their old MCP App resource URI to
the new URI in memory, without rewriting history. Existing ingest and OAuth secrets
remain valid; token prefixes (`foi_`, `foa_`, `for_`, `foc_`) are unchanged for
both existing and new tokens because there is no central token-prefix registry.
- HTTP request headers and metrics use the Pitot name. Update custom clients
using the product request header to `Pitot-Request` (and dashboard deletion confirmation to
`Pitot-Confirm-Delete`), and update Prometheus
queries and alert rules from the old metric prefix to `pitot_`.

Take a cold backup before upgrading, stop the old service, replace the binary or
image, and start the new service against the same data and secrets. Verify
`/readyz`, sign-in, ingest and a representative query before resuming traffic.
2 changes: 1 addition & 1 deletion CLA.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LabStack Contributor License Agreement

Thank you for your interest in contributing to a project of LabStack LLC
("LabStack", "we", "us"), such as Driga, Fanout, or Onebox.
("LabStack", "we", "us"), such as Driga, Pitot, or Onebox.

This Contributor License Agreement ("Agreement") documents the rights granted
by contributors to LabStack. It applies to any Contribution you submit to any
Expand Down
Loading
Loading