Docker

1. Start it

The command

docker run -d --name fermi \
  --network host \
  -v fermi-data:/data \
  -v /srv/documents:/documents:ro \
  ayerselectronics/fermi

--network host

Required. FERMI refuses requests that arrive through a published port (-p).

-v fermi-data:/data

FERMI's index, language model, settings and logs. It survives restarts and updates. Never add it as a document folder.

-v /srv/documents:/documents:ro

Your documents. Replace /srv/documents with your own folder; inside the container it is /documents. The container's unprivileged user must be able to read it.

2. Open it

In a browser

Open http://localhost:27400 on the computer running Docker, then see Getting Started.

Health check

/health on the same port answers while FERMI is up.

Updating

Pull, remove, start again

docker pull ayerselectronics/fermi
docker rm -f fermi
docker run -d --name fermi \
  --network host \
  -v fermi-data:/data \
  -v /srv/documents:/documents:ro \
  ayerselectronics/fermi

Your index and settings stay in the fermi-data volume.

A host folder for state

To keep state in a folder on this computer instead of the volume, give that folder to the container's user first.

Getting help

Docker Hub

hub.docker.com/r/ayerselectronics/fermi has the tags.

Something wrong

Report an issue.