A whiteboard for your own server: notes, shapes, drawings and photos, edited live together.
1.5K
A whiteboard for your own server, in the spirit of Apple Freeform: sticky notes, shapes, text, lines, pen and highlighter, photos and PDFs on an endless board, edited by several people at the same time. Self-hosted, for yourself, a family or a small team.
nexcanvas is one of the nex apps and looks like them: coral, dark and light. Whoever knows nexlore finds the same frame here, with the same accounts, second factor, sign-in through a provider, log, languages and backups.

A network plan from a template. The board takes the whole window; the tools stand on the left, and beside them the shape library opens: packages as groups, search, favorites and recent shapes. Drag a shape onto the board or click it and draw it to size. Lines dock at the edge a shape really has.

A floor plan to scale, one unit a centimetre: walls, doors, windows and furniture from the floor plan package, a dimension line, the board on a grid that things snap to.

A flowchart. Every shape carries its text; the "+" on a selected shape adds the next one and joins it, Tab adds a child and Shift+Tab a sibling.

Over thirty templates in groups (to begin, flow and process, project, rooms, network, thinking, organisation), plus your own: save a board as a template, with its content or only the skeleton.
Light and dark, and on the phone with every tool at the bottom of the screen.
.canvas file the way Obsidian writes it, with its photos and files in a ZIP
archive, and a canvas from Obsidian or nexlore comes in, into an open board or as a new one. What only nexcanvas
knows (shapes, drawings, turned things, the background) travels along unseen and comes back whole, so a board
moves from one nexcanvas to another as a file.services:
nexcanvas:
image: ghcr.io/derkezorm/nexcanvas:latest
container_name: nexcanvas
restart: unless-stopped
ports:
- "8500:8000"
volumes:
- ./data:/data
environment:
PUID: 1000
PGID: 1000
TZ: Europe/Berlin
docker compose up -d
Built from source instead: clone this repository, put build: . in place of image: and run
docker compose up -d --build.
Open http://<your-host>:8500. The first account you create there is the operator. It needs the setup code
from the server's log, so that nobody who reaches a fresh instance first can take it:
docker logs nexcanvas
shows the setup code, new at every start until nexcanvas is set up. To choose it yourself, set
NEXCANVAS_SETUP_TOKEN. docker-compose.yml in this repository has the same service with every option explained.
Put nexcanvas behind a reverse proxy with TLS before you use it from anywhere but your own desk, and let the
proxy pass WebSockets through: boards are edited live over /api/boards/<id>/live.
nexcanvas is made to be reachable from outside, for yourself on the road or for a small team. Before you open it:
127.0.0.1:8500:8000
when the proxy runs on the same host, or keep both on a Docker network without a published port. Pass WebSockets
through, and send HSTS from the proxy.NEXCANVAS_PUBLIC_URL (the address people use), NEXCANVAS_TRUSTED_PROXIES
(the proxy's address or network; without it every sign-in seems to come from the proxy and the brake against
guessing cannot tell people apart; Settings, Server says so while it is missing), and
NEXCANVAS_COOKIE_SECURE: "on". NEXCANVAS_TRUSTED_PROXIES also makes nexcanvas believe the proxy's
X-Forwarded-Proto (the rightmost value of the header): without it the sign-in setup (the authentik button) sees
the address as http:// and warns that the redirect address would not match; that warning points here.NEXCANVAS_OPERATOR_NETWORKS: "192.168.0.0/16" refuses them
from anywhere else (behind a proxy only together with NEXCANVAS_TRUSTED_PROXIES).latest, update on purpose, back up before.Everything lives in /data: the SQLite database nexcanvas.db (accounts, spaces, boards and their versions),
media/ (photos and files, with smaller copies of large photos), secret.key, backups/, logs/, locales/.
Mount it from a local disk, never from an SMB or NFS share: SQLite's locking does not work reliably over network
filesystems.
Back it up with nexcanvas's own backups (Settings, Server, Backup), which copy the database consistently while it runs and take every photo and file along. A backup is a plain ZIP; whoever has it has everything, so keep downloaded copies as carefully as the data directory itself.
Moving to a new server: download a backup, set up nexcanvas there, upload the backup under Settings, Server, Backup, check it and restore it. Afterwards the new server has the old accounts, spaces, boards, photos and files.
With an image: docker compose pull && docker compose up -d. Built from source: pull the new code and run
docker compose up -d --build. nexcanvas adds what the database lacks at the start; nothing needs doing by hand. Make a backup before a big jump anyway.
| Variable | Default | Meaning |
|---|---|---|
NEXCANVAS_DATA_DIR | /data | Database, photos and files, logs, backups, languages |
NEXCANVAS_MEDIA_DIR | <data>/media | Photos and files of the boards |
NEXCANVAS_LOCALES_DIR | <data>/locales | Extra languages, one JSON file each |
NEXCANVAS_SECRET_KEY | created on first start | Protects server-side secrets; when set, it wins over secret.key |
NEXCANVAS_PUBLIC_URL | from the request | The address people use to reach nexcanvas, for invitation links, public pages and the redirect addresses of the sign-in providers. The setting in the interface wins when set |
NEXCANVAS_TRUSTED_PROXIES | none | Addresses or networks of reverse proxies whose X-Forwarded-For and X-Forwarded-Proto are believed, comma separated |
NEXCANVAS_SETUP_TOKEN | made at start | The code the first account needs |
NEXCANVAS_OPERATOR_NETWORKS | none | Networks the operator's settings may be changed from, comma separated |
NEXCANVAS_UPLOAD_MAX_MB | 50 | The largest photo or file; the operator can lower it in the settings |
NEXCANVAS_SESSION_DAYS | 30 | A browser session ends after this many days |
NEXCANVAS_LOG_LEVEL | stored setting | quiet, normal, detailed or trace; overrides the setting |
NEXCANVAS_COOKIE_SECURE | auto | on, off or auto (from the request, or X-Forwarded-Proto of a trusted proxy) |
NEXCANVAS_API_DOCS | false | Serves /api/docs and /api/openapi.json |
PUID, PGID | 1000 | Owner of the files in the data directory |
nexlore keeps notes, nexcanvas draws. Between them, and with Obsidian, boards travel as JSON Canvas
(jsoncanvas.org): notes, texts and shapes become text cards, photos and files file cards,
links link cards, frames groups, lines between two things edges. Formatted words go out as Markdown. Drawings, timers,
lines with a free end and the full formatting of the words are kept in a nexcanvas block the others leave alone. Coming in, a text card becomes a note in the nearest of the seven colours,
a group a frame, and a file card the photo or file of that name from the archive.
n8n and your own scripts can read nexcanvas with an API token: the boards, numbers for a dashboard and a small picture of each board. Off until the operator switches it on; every account then makes its own tokens. Reading only. The routes are in docs/api.md.
X-Nexcanvas-Client, which a page on another site cannot send; the live
connection checks where it comes from and checks the rights of each connection again every 30 seconds, so a
member taken out of a space is out of its boards at once.cd backend && python -m venv .venv && .venv/Scripts/python -m pip install -r requirements-dev.txt
.venv/Scripts/python -m uvicorn app.main:app --port 8500
cd frontend && npm ci && npx vite
On Linux the virtual environment's programs are in .venv/bin. The frontend on port 5500 sends /api, the live
connection included, to the backend. Tests: python -m pytest -q in backend, npx vitest run in frontend.
AGPL-3.0.
The buttons and the icon packages of the shape library use the Lucide icons (ISC, partly MIT
from Feather); their notice is in frontend/public/licenses/lucide.txt and ships with the app at
/licenses/lucide.txt. Everything else nexcanvas ships or depends on, with its licence, is listed in
THIRD-PARTY.md.
Content type
Image
Digest
sha256:fa60e34b4…
Size
90.9 MB
Last updated
about 21 hours ago
docker pull derkezorm/nexcanvas