Local folder

The simplest source: a folder of .md, .markdown, and .txt files, such as a clone of your IT docs repo.

docs:
  sources:
    - type: local
      name: runbooks
      path: ./docs
      url_base: https://github.com/acme/it-docs/blob/main

Key	Meaning
`path`	Folder to index.
`url_base`	Optional. Links in answers become `url_base` plus the file’s path, such as `https://github.com/acme/it-docs/blob/main/vpn/setup.md`. Without it, links are `file://` paths that your users can’t open.

Scope

Everything under path, including subfolders. To index less, point path at a subfolder. To index two folders, add two local sources with different names.

With Docker

In Docker, your project’s docs/ folder is at /app/docs, so path: ./docs works out of the box. To index a folder outside the project, change that volume in deploy/docker-compose.yml:

volumes:
  - /srv/it-docs:/app/docs:ro

Syncing

Deskhand syncs on startup and every docs.sync_interval_minutes. It re-indexes only files whose modified time changed and drops files that were deleted. If you remove the source from the config, its documents are deleted at the next sync.