Fieldset documentation

Fieldset is a free, self-hostable platform for digital forms. Office staff design forms in the admin dashboard (/admin); field workers fill them in on a phone or tablet with the Field App (/app), also offline; the server numbers each submission, renders a branded PDF and runs workflows such as a review followed by an email to the customer.

These guides describe the current release. They are plain Markdown and work offline in a clone of the repository (ADR 0042, ADR 0094). Each release's guides are also published, with search and the interactive API reference, at beyerenrico.github.io/fieldset.

For operators

Guide	Contents
Install	The one-line install, local, domain and proxy modes, phones, mail capture, demo data, the instance directory, adopting a 1.0 install
Agent guide	Recipes for AI agents and scripts: exact fieldset commands, the JSON fields to read, exit codes and recovery
Upgrade	fieldset upgrade with its safety backup and automatic rollback, fieldset rollback, the Field App update
Backup and restore	The backup schedule, encryption, drills, fieldset restore, moving to another server, chain epochs and the ledger
Configuration	fieldset config and every key, SMTP, what fieldset sets for you
Troubleshooting	fieldset status, doctor and logs, failed commands, certificates, proxies, mail, PDFs, Field App sync, SSO, login throttling, the audit log
Archive: 1.0 checkout installs	The 1.0 guides for installations from a clone of the repository: install, upgrade, backup and restore, configuration, troubleshooting. Not for fieldset instances

For organizations

Guide	Contents
Admin guide	Roles, members and groups, forms and both builders, designs, submissions and reviews, workflows, reports and dashboards, mail settings, single sign-on, API tokens, the audit log, retention, legal holds and personal data, the /platform operator panel
Field App guide	Installing the app, signing in, filling in and submitting forms, offline use and sync states, sending the PDF, reviews, keyboard use, personal data requests

For developers and integrators

Document	Contents
API and integrations	The REST API, the OpenAPI document at /docs/api, webhooks and signature verification
Field App API contract	The normative /api/v1 contract
Fieldset Spec 1.0	The open JSON format for form definitions (MIT)
Architecture decisions	One ADR per decision
README	Development setup, demo data, checks
Changelog and release notes	What changed in each version
Security policy	How to report vulnerabilities

Terms used in these guides

Term	Meaning
Organization	A company using the instance. Every record belongs to exactly one organization.
Form / form version	A form definition. Publishing creates an immutable version; submissions keep the version they were filled with.
Submission	One filled-in form, from draft to completed. The server assigns its number on submit.
Rendition	A PDF created from a submission with a design. PDFs are never changed; re-rendering creates a new one.
Design	Paper size, header, footer and layout of the PDFs, versioned like forms.
Workflow	A trigger, optional conditions and steps such as a review, an email or a webhook.
Field App	The installable web app for phones and tablets at /app.