Requirements
Lecture's server side is small because the browser does the heavy lifting. A single modest VM — the cheapest you can rent, or a spare machine in the faculty — is enough for a study group or a small course.
Host
| Operating system | Anything that runs Docker Engine well: a current LTS Linux distribution is the standard choice (x86-64). macOS and Windows work for trying it out. |
|---|---|
| Container runtime | Docker Engine (a current stable release) with Compose v2 — the docker compose subcommand, not the legacy standalone docker-compose binary. |
| Memory | Plan for about 2 GB of RAM for the whole stack (app + PostgreSQL) plus headroom for the rest of the system. |
| Disk | A few GB to start. Text notes and canvases are tiny; plan space for container images, database growth and — more importantly — your backups. |
| Uptime | Set Docker to start on boot so the stack comes back after a reboot (clients keep working offline in the meantime, so a reboot is never urgent). |
Database
Lecture runs on PostgreSQL 17. You do not need to install it: the example compose file starts an official postgres:17 container with a named volume that holds all your data. If you prefer to manage your database server yourself, point the connection string at it and skip the container — but keep a version at or above 17.
All Lecture state lives in that one database plus uploaded files inside the app's storage; there is no other hidden state on the host. That is also what makes backups simple (see Updating).
Network
- The app serves plain HTTP on one port (default example:
5080). Terminate TLS with your reverse proxy in front of it before real users connect — and make sure the proxy supports WebSocket upgrades, since live sync uses them. - Users' browsers need to reach the server over HTTPS. The server itself needs outbound HTTPS only to pull images.
Browsers (your users)
- A current version of Chrome/Edge, Firefox or Safari — desktop and mobile.
- The app is an installable PWA: install it once, and opened documents keep working with no connection and sync later.
- The first visit downloads the application bundle (WebAssembly); expect one slow load, then instant ones. No plugin, no separate client to deploy.
Pre-1.0 caveat: these numbers describe today's prototype. They will be pinned down and guaranteed as part of the 1.0 work.