Development

Go 1.27 is used in the Docker image. Node.js 22+ is needed only for the Cloudflare Worker.

go test ./...
go vet ./...
go build ./...
gofmt -l .
go run ./cmd/interim

Match the existing style: gofmt, no new dependencies without a reason, and tests for behavior changes.

Test coverage

The test suite uses an in-memory fake object store and covers setup token enforcement, auth, upload-intent creation, staging-to-live copy-on-complete, single-PUT completion, multipart part URLs/reporting/status/completion/abort, exact part-size validation, oversized-provider-part rejection, abort-failure retention, orphan multipart sweeping, endpoint rate limits, multipart janitor cleanup, idempotent completion, direct upload verification, ownership, per-client and global quota rejection, abort, janitor expiry, orphan sweeping, expiry cleanup, admin deletion, restricted-upload enforcement, admin-generated hashes, approval changes, trusted-proxy parsing, cookie naming, and schema migrations.

S3 integration, CORS, CopyObject, multipart, and presigned PUT behaviour must be tested against your provider.

Build the binary directly

CGO_ENABLED=0 go build -trimpath -o bin/interim ./cmd/interim

Worker

cd worker
npm ci
node --check src/index.js

Deployment for the Worker is covered in B2 with a Cloudflare Worker.

Documentation site

This documentation site is a separate repository that builds with ProperDocs. To preview changes:

pip install -r requirements.txt
py -m properdocs serve

Then edit docs/ and the dev server reloads automatically. Before opening a pull request, build with warnings treated as errors and check internal links:

py -m properdocs build --strict
python scripts/check_links.py

Related pages

• Architecture — how the packages fit together.
• Contributing guide — repository rules.
• Configuration — runtime settings.