Bifrost Docs

Bifrost Docs is an installable Bifrost Solution for organization-scoped operational documentation. It provides native document authoring, folders, attachments, configuration records, safe search, audit history, and an optional IT Glue migration connector.

Native documentation works without IT Glue. Installers configure only the roles and the Bifrost platform resources needed for their organization. IT Glue is an optional one-way migration source for teams that have an existing IT Glue account.

Install

Use Bifrost CLI 1.4.2 or later against the intended Bifrost instance:

git clone https://github.com/gobifrost/docs.git
cd docs
bifrost solution deploy . --global

Use --org <organization> when the Solution should be installed for one organization. The install creates the Solution-owned tables, file locations, workflows, agent, and app described by the manifests. It does not include table rows, managed files, integration credentials, or customer data.

Assign the supplied Bifrost Docs Reader, Bifrost Docs Editor, and Bifrost Docs Administrator roles before opening the app. Verify a non-administrator role after install: platform administrators bypass normal policy checks and do not prove the role configuration. Bifrost Docs requires the platform authorization behavior from Bifrost #791, which evaluates both the existing row and the proposed row for updates, upserts, and batch writes. Every installation still needs fresh role and file-policy verification; this package does not claim that its roles have already been tested in your environment.

Development

Bind the checkout to a non-production install, then use the platform-selected SDK:

bifrost solution bind --solution <install-id>
bifrost solution sdk update . --app bifrost-docs
bifrost solution start bifrost-docs

bifrost solution start supplies the selected instance, authentication, and Solution scope through its local proxy. The app never commits an instance URL or authentication token. The server-side Solution builder injects the API-matched web SDK during deployment.

After selecting the SDK with solution sdk update, run the focused checks from the repository root:

docker run --rm -v "$PWD:/workspace" -w /workspace python:3.12-slim \
  sh -lc 'pip install pytest pyyaml && python -m pytest -q tests'
npm --prefix apps/bifrost-docs test
npm --prefix apps/bifrost-docs run build

Optional IT Glue migration

The IT Glue connection in .bifrost/connections.yaml is optional. To migrate existing records, a Docs Administrator configures its API key as an Integration secret and maps each Bifrost organization to its IT Glue organization ID. The migration is API-first, resumable, and one-way: it never downloads an account ZIP, does not create organizations from names, and never migrates password or TOTP values.

Mapped source records preserve local edits until the source changes. Native Bifrost records are not overwritten by the migration. Review the migration and rollback checklist in docs/CUTOVER_RUNBOOK.md before a production cutover.

Optional AI profile

The Documentation Agent is included without a model selection. If your platform requires an AI profile or model assignment, configure it after installation according to your Bifrost instance policy. The agent searches only documentation data that the caller is authorized to access and excludes passwords, TOTP secrets, integration credentials, signed URLs, and protected ciphertext from its context.

Security and support

Read SECURITY.md before reporting a vulnerability. Use the public project URL https://github.com/gobifrost/docs for issue tracking and releases.

This project is licensed under the MIT License.