Documentation

Everything about building with and running AbiData.

User guide

• WelcomeWhat AbiData is and where to start.
• TablesDefine fields, link tables, edit records, resolve conflicts, filter and sort.
• QueriesBuild and save queries visually or in SQL, use parameters, and know who can run or save them.
• FormsDesign data-entry forms, attach Lua event handlers, add calculated controls and subforms.
• ReportsDesign banded reports with grouping and totals, then print or save them as PDF.
• ScriptsWrite Lua for forms, reports and jobs; know the contexts, time budgets and limits.
• JobsRun scripts on a schedule, handle overlap, misfires and retries, read logs, and allow outbound requests.
• Imports and exportsBring CSV, Excel and JSON data into tables and export tables and queries.
• BackupsManual, scheduled and restore-point backups, and how to restore a workspace.
• API accessLet bots and other programs read and write a workspace with an API key.
• Public appsPut forms and reports on a page anyone with a secret link can open, without an account.
• BlogsWrite and publish posts at /b/{username} from your blog workspace.
• MessagesSend direct user-to-user messages and workspace threads with replies.
• Members and rolesWhat viewers, editors, builders and owners can do, and how to manage members.
• Using the keyboardWork without a mouse, and find the full list of shortcuts.
• Install on your phoneAdd AbiData to your phone's home screen so it opens like an app.
• Example: tracking invasive speciesA walkthrough of the Biosecurity Watch sample workspace, with maps, quarantine zones, photos, spatial queries and API calls.

Operations

• InstallRun AbiData with Docker Compose and Caddy, create the first administrator, and know which volumes hold your data.
• ConfigurationEvery ABIDATA_* environment variable, its default and how it is validated.
• PostgreSQLRun an install on PostgreSQL instead of SQLite. Covers the database and role it needs, its settings, what differs, how to back it up and how to move an install between backends.
• UpgradeBack up first, upgrade, and how to roll back.
• Backup strategyWhat to back up, the retention defaults, off-site copies, and why the manifest key must be kept.
• SecurityThe threat model in short, the egress policy, roles, and what you must do as the operator.
• MonitoringThe admin dashboard, health checks, Prometheus metrics, JSON logs and the administrator's live log stream.

Reference

• Lua API referenceEvery function scripts can call, with parameters, errors and examples.
• Error referenceWhat each error code means and how to recover.
• Keyboard shortcutsEvery keyboard shortcut, with Mac and Windows/Linux keys.
• ExpressionsThe expression language for calculated fields, validation rules, defaults and query expression columns, with every function.