Repository navigation
docs(release): align the docs with marfa v0.0.14 - #513
Merged
Merged
Conversation
aicayzer
commented
Oct 19, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. Brings the docs in line with v0.0.14: the published server image, each instance's replica under its own prefix, the new exit codes, private webhook addresses, telemetry that names the instance, missing blobs in archives, the folder push and file-write proof. Safe to merge once the v0.0.14 release and image are public.
First draft: 4/5. One untrue sentence found and fixed.
Checked.
- True: every changed claim against the marfa code at tag
v0.0.14: exit codes, setting names and defaults, the image name and run command, the<S3_PREFIX>/dbreplica path andlitestream restorecommands,TRUSTED_PROXY_CIDRS, the telemetry start, webhook refusals and the changelog entry. - Generated data: the sync from the tag produces no diff in
src/generated/oropenapi.json.
Found.
folders restorewas said to print a flag for a file it could not write. The text output prints the path and reason; the flag appears only with--json. Fixed in 10b7a89.
Quick fixes. 1 applied by the reviewer.
Reviewed by withmarfa-reviewer on claude-sonnet-5-5. This review may contain mistakes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the docs in line with Marfa v0.0.14: the published server image, the per-instance backup prefix, the CLI exit codes, webhooks to private addresses, telemetry attributes, backups that name missing blobs, folder push exits and the file-write refusal. The release sync is the first commit, so the generated release data, the CLI download and the settings and error tables name v0.0.14.
Changes
chore(sync)runsscripts/sync-from-marfa.shagainst thev0.0.14tag (generated files only).feat(sync)addssrc/generated/server-image.md, written from the release likecli-download.md, with its test insync-from-marfa.test.shanddocs-structure.test.ts.ghcr.io/withmarfa/marfa-serverby release tag (from the generated snippet) and publishes the port on loopback, with the reason.TRUSTED_PROXY_CIDRSfor a proxy on the same machine, and why (sign-in limits count each address). The bare-metal start isnode --import ./dist/instrumentation.js dist/index.js. Upgrade names the old build by its image tag, gives the new build its own volume, port andS3_PREFIX, and checksrelease.<S3_PREFIX>/dbin deploy, back up and restore (with theS3_PREFIX=form oflitestream restore) and upgrade.missing_blobs,blobs_missing, the exit codes 1 and 3, thenulltype and size, and503 blob_store_unavailable.keys keepaccepts any valid key,eventsexit codes,owner passkeys add, andreleaseinmarfa whoamiandstatus.dead_letterat once, and unstoredTailscale-headers.service.instance.id,OTEL_RESOURCE_ATTRIBUTES,OTEL_SERVICE_NAMEprecedence, for the server and the CLI.folders pushexits, the rate limit, thewaitingcount,folders restorelisting, the UTF-16 move,404 blob_not_foundon a file write and itsIdempotency-Keybehavior.Testing
pnpm test(354 tests, including the content lint),pnpm build,pnpm build:statusandpnpm types:checkpass, and.github/scripts/sync-from-marfa.test.shpasses (597).v0.0.14(the contract,openapi.json,deploy/README.md, the server and CLI source).Notes for reviewers
docker pulland the CLI download URL fail, and the changelog link to the v0.0.14 release is a 404, until the release is published and the package is made public. Merge after that.waitingcount is explained in "Know whether a push finished" in the sync guide.TRUSTED_PROXY_CIDRSfor the container network is derived fromclient-ip.ts(the server trustsX-Forwarded-Foronly from a trusted peer) and Docker's publishing behavior. It was not run with a real proxy.src/generated/server-image.mdis written by the sync script, never by hand.Checklist
STYLE.md, with American English and no em dashes.