The Fieldbook project
Fieldbook is designed for independent installations: you control your own content, data, and services. The project develops the reusable software and documents how to run it.
The software, project site, and demo
These three parts of the project have different purposes:
- The GitHub repository (opens in a new tab) contains the free, reusable application code, its license, and instructions for installing, upgrading, and contributing to the software.
- thefieldbook.org is the project's home and an installation running The Fieldbook software itself. Its content and settings belong to that installation.
- The interactive demo (opens in a new tab) lets you explore a fictional organization, including switching account types to explore Learner, Manager, Contributor, and Administrator features. It uses sample profiles and browser-local data; your changes stay in your browser.
Running your own installation
An independent Fieldbook has its own accounts, content, learner records, media, and configuration. The operator supplies the service accounts, covers their costs and chooses access settings, privacy practices, storage limits, backups and update arrangements.
The documented setup uses Next.js on Vercel, hosted Supabase for the database, authentication, and private media, and Google sign-in. Running an installation means setting up those services for your organization; using the project site or demo does not set them up for you.
To set up your own installation of The Fieldbook, follow Install Fieldbook and the docs/installation.md guide in the source you install.
Docs describe Fieldbook as it works now
We update affected articles when Fieldbook changes so these Docs remain a current reference.
The source-available license
Fieldbook is developed with AI-assisted coding and distributed under the Elastic License 2.0 (ELv2). It permits using, modifying, and redistributing the software under its terms, including running an internal installation.
Most notably, this license expressly prohibits offering third parties a hosted or managed service that gives them access to a substantial set of Fieldbook's features.
Read the full Elastic License 2.0 terms (opens in a new tab) for the complete permissions and conditions. Third-party components retain their own licenses; the repository's third-party notices (opens in a new tab) record relevant attribution.
The ambition of The Fieldbook project
The goal is delightful, easy to use software a small team can understand, maintain, and adapt to their needs. The code separates hosting, data, identity, and media storage integrations from product behavior. The aim is to make other services practical to add without redesigning the whole application.
Portability is a key aim for the project. The installation guide describes the supported hosting, database, and sign-in setup.
For changes to the software, start with the contribution guidance (opens in a new tab). For a suspected vulnerability, follow the security reporting guidance (opens in a new tab) and keep vulnerability details out of public issues.