nooks
GitHubInstall

Documentation

Install Nooks, configure it, hand out access tokens, and run an instance a household can depend on.

Nooks is one binary. It serves the API and the app from the same process and keeps everything in one SQLite file you can copy: no separate database to stand up, no queue, and no mail server.

Start here

How these pages are organised

Deploy and Configure get an instance up and pointed at the right database and domain.

Using Nooks is written for the people on the list rather than the person running the server, so it can be sent to somebody in the house as a link.

Running an instance is the settings only an admin sees: people, groups, access tokens, and what the instance calls itself.

Operations is the two things you will do again — backing up and upgrading — plus the failures that actually come up.

The API has a section of its own. Its reference is generated from the same definitions the server is built from, so it cannot describe an endpoint that is not there, and a check in CI refuses an endpoint that ships to the browser only.

On this page