Skip to content
footnote Docs
Install

Where to run Footnote

Footnote has three parts: the service, the web app and a PostgreSQL 18 database. There are three ways to run them. Docker Compose is the default, and Try the demo uses it. To run Footnote for your own team, run the same images on a host you choose. Vercel with Neon is only for the demo.

Docker ComposeA cloud host or container platformVercel with Neon
What it is forTrying Footnote on one computerRunning Footnote for your own team, on AWS, Railway, Fly or another hostThe demo, and nothing else
What you rundocker compose up: PostgreSQL 18, the service and the web appThe service image, the web image and a managed PostgreSQL 18, behind an https proxyA Vercel project with the service as a function, and a database on Neon
What you manage yourselfThe computer, Docker, and the backupsThe database, the https proxy, the keys, sign-in, backups and upgradesThe demo’s snapshot, its roles and its settings
What has been testedCI starts it with the demoCI boots the images in production mode. No named host has been testedTests build the function and call it, without deploying it

Docker Compose

Try the demo installs it, Use your own data runs it on your own semantic layer, and Back up, restore and upgrade keeps what people wrote. compose.yaml sets NODE_ENV to development, which turns on the demo’s people picker, so keep both ports on this computer.

A cloud host or container platform

This is the way to run Footnote for real people. It asks three things of a host: it runs containers, keeps a folder between restarts, and ends https in front of them.

Not tested on a named host. CI boots both images in production mode, against a stand-in sign-in provider and a PostgreSQL 18 container. The project has not tested them on AWS, Railway, Fly or a managed PostgreSQL, so this page gives no steps for any of them. Expect to work out the host’s own part yourself.

Run in production has the steps, the settings and the proxy in front, the database guide says how to set up the roles, and Set up company sign-in has every sign-in setting.

The proxy in front

The proxy in front of the containers is now in Run in production.

Vercel with Neon

This runs Footnote’s demo only. Run the demo on Vercel and Neon has the whole setup. It is not a way to run Footnote for your own team.