Skip to content

Releases

v0.22.1

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 09:44

A patch release that fixes what the second security review of 0.22.0 left open for a public demo (KNOWN-ISSUES
LIMITS-37 to LIMITS-42), and a memory fault present since 0.21.1 on every server: rewriting a large page body could
run the server out of memory. A public demo for strangers can run from 0.22.1 on, on a filesystem of its own
(docs/DEMO.md, step 0). No database migration (63 applied migrations, as 0.22.0), no new setting for the app, no new
dependency, no API route added or removed, and the MCP tool list and server instructions are unchanged. Design
notes are docs/adr/2540-* .. 2552-*. What is left is in docs/KNOWN-ISSUES.md, "Added in 0.22.1".

Not tried in Safari, Firefox or on a real phone; the memory numbers below were measured on macOS, not in a Linux
container (KNOWN-ISSUES, "Added in 0.22.1").

What changes on every server

These change with no setting, on every server that upgrades:

  • The inbox document is read-only (docs/adr/2542-*). The server only sends notices on it and the web app never
    writes to it. Its connection is now authorised read-only, and an update to it that carries any content is
    refused before it is decoded: the server cuts that socket. Before, any signed-in account could grow its own inbox
    document in the server's memory without bound (since 0.21.1). Notifications are unchanged.
  • Awareness has caps (docs/adr/2541-, 2552-): a document connection may bring at most 4 client ids of its own
    into a document (ids already there, which the web app's provider sends back for everyone else, do not count), a
    socket may add new client ids 64 at once and then one a second, a document holds at most 1024, a state at most
    16 KB, a message at most 1 MB, the states a socket brought in at most 256 KB, and a socket may change 128 KB of
    states at once and then 16 KB a second (resent states that change nothing are free). A message past one of the two
    rates (new ids, changed states) is dropped: it is not applied and nobody is sent it, the socket stays, and the next
    state the client sends replaces it, so a cursor moved very fast only skips positions. A message past one of the
    other caps is never applied and the server cuts the socket; the provider reconnects. The web app brings in one id per document.
    Before, a member could fill the server's memory with awareness states, also from a read-only connection.
  • The cap of 40 collaboration sockets per client address counts an IPv6 /64 as one address (docs/adr/2544-*), as
    the request rate limit does since 0.22.0. Everyone behind one IPv6 /64 now shares 40 sockets (the web app opens one
    per tab, so about 40 tabs), as everyone behind one IPv4 NAT always has. The 40 is a constant in the code
    (MAX_CONN_PER_IP in apps/server/src/collab.ts), not a setting. The upgrade-attempt throttle stays per full
    address.
  • Rewriting a large range of a page has an edit budget (docs/adr/2550-, 2551-): update_page and
    patch_section with replace, patch_sections, a revert batch, POST /api/pages/:id/content with replace and
    the other paths of the minimal edit. When the old and new blocks of the range hold more than 128 KiB of characters together, the edit
    gets a budget (2,000 Yjs text operations, 40 million diff steps); past it, a changed block keeps its id, colors,
    alignment and toggle, and its content is replaced whole instead of edited character by character. What such a
    block loses: characters someone typed into it at the same moment, underline and text colors (Markdown cannot carry
    them), and inline nodes the Markdown did not carry. Comments and block links stay (they point at the block id).
    Ranges up to 128 KiB are edited exactly as before. Before, rewriting about 1 MB of different text ran the server
    out of memory on the second request, with a 320 MB and with a 512 MB heap (present since 0.21.1); the numbers are
    in docs/PERFORMANCE.md. After a large Markdown body is parsed the server lets go of the parsed document at once.
  • An agent's replace of a body over 2,000 blocks or over 256 Ki characters of Markdown records no line counts in
    its AI step (±lines), as a replace of a page over 2,000 blocks already did. Counting meant exporting the whole
    body once more.
  • Page access audit rows keep the person's id (personId beside person in page.access_granted,
    page.access_changed, page.access_removed and the grant of an accepted page invitation; docs/adr/2547-*), so an
    account that deletes itself or expires loses its name from them. The audit screen and route do not show personId.
    Rows written before 0.22.1 have no id and keep the name.
  • Account deletion (by the person or by expiry) also clears the invited address of page.guest_invited rows whose
    address is the account's own sign-in email or ID. Another account cannot have that address, so a namesake's rows
    are not touched. An admin's deletion is unchanged.
  • Each search index pass counts itself and makes one call that returns at once without a storage limit (the
    storage count below waits for it). Nothing else changes for a server without limits.

Only with a storage limit or the fuse

What follows runs only with LIMIT_WORKSPACE_STORAGE_MB (the fuse items with LIMIT_INSTANCE_STORAGE_MB, the
structure cap with either). A server with neither counts and answers as 0.22.0.

  • Small files count as at least 5 KB (docs/adr/2545-*): an upload counts max(size, 4,096) + 1,024 bytes in the
    workspace's storage, in the recount, in the upload's check and in GET /api/workspaces/:id/usage (storageBytes
    and fileBytes). Empty uploads are still allowed; they are no longer free. A workspace of 10 MB therefore holds at
    most 2,048 files.
  • The search and section indexes count (docs/adr/2545-): the recount adds the rows of page_texts, page_chunks,
    page_chunk_vectors, page_tasks, page_links, page_tags and page_former_titles. They are written 8–30 s after
    a body is stored, so the store reserves 2 bytes per byte the body grew, and the reservation stays in the count until
    a recount has seen the index pass's rows (docs/adr/2548-
    ). A recount 0.5 s after that pass, or 40 s after the
    store, puts in the real number. A store that finds the count more than 10 minutes old recounts after its own write,
    not beside it.
  • Live editing is admitted with its index to come (docs/adr/2548-*): an update over the collaboration socket
    passes when cached use + 3 × (unsaved growth + the update) + the next version copy stays within the limit. The
    index comes to about twice the body, so a workspace filled through the editor stops below its limit: measured with
    the demo preset, a burst of pastes of about 1 MB into a 10 MB workspace ended at 71 % of it with prose and 91 % with
    random words after the recount (counting the body alone, the same burst ended at 214 % and 274 %). Content that has no search
    index (text outside the page body) is counted × 3 too until a recount, for up to 40 s. A 1 MB paste followed by
    typing first met a read-only moment at a real use of 5.5 MB. REST and MCP body writes are checked against "full",
    not against their size, so they can still end one write past the limit (115 % and 131 % with 1 MB appends).
  • A live page holds at most 300,000 Yjs structures (docs/adr/2540-*). The bound of an update is read from its
    bytes before it is applied; an update past it is refused and connections to that page open read-only for 10
    minutes, also when a recount finds room in the workspace. Ordinary pages measured far below it (207,000 for 4.1 MB
    of stored Markdown).
  • Unsaved growth is what the document took in (docs/adr/2543-*): an update the page already held counts 0 bytes
    (before, each re-sent copy counted its length).
  • Going over the limit reconnects editing read-only (docs/adr/2549-*). When a store or a recount takes a workspace
    past its limit, or a page body past its cap, each editing connection gets the stateless message
    {"t":"storage","why":…} and its socket is closed with code 4000 storage-full; the provider reconnects at once,
    read-only, and is closed again and comes back able to edit when a recount finds room. Before, these connections got
    4403 permission-changed, the web app showed the page as disconnected and typing never reached the server again
    until a reload. 4403 stays for access that changed.
  • The fuse counts disk blocks (docs/adr/2545-*): every file and folder under the data folder counts
    max(size, blocks × 512), walked 64 at a time. A measurement older than a minute is answered from the last one
    and measured again in the background, so a write never waits for the walk; only the first answer after a start
    waits. So the first write after the fuse is released can still be refused once.
  • A 413 LIMIT_STORAGE to a page guest carries no used and limit (docs/adr/2547-*); members still get them.
    PATCH /api/pages/:id checks storage only after the edit check, so someone who can only read the page can neither
    move the cached count nor read it from the answer.

Demo preset

  • DEMO_IMAGE (docs/adr/2546-*): the demo runs an image name of its own (inkling-demo:local in the example).
    demo.sh refuses a name without demo in it and production's image name; up builds it when it is missing, and the
    new demo.sh build rebuilds it after an update.
  • DEMO_VOLUME_ROOT: the four volumes are folders under one absolute path, where the operator mounts a filesystem
    of its own. demo.sh up refuses a path on the root filesystem or on Docker's data folder's filesystem;
    DEMO_ALLOW_SHARED_DISK=1, set in the shell for one command, lets a laptop trial go on with a warning. destroy
    never deletes files on the host: it prints where they are.
  • LIMIT_WORKSPACE_STORAGE_MB 20 → 10 (with the indexes counted, 100 full workspaces fit under the 3,000 MB fuse).
  • The app's heap 320 → 448 MB in a 7...
Read more

v0.22.0

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 09:12

A minor release for operators who want to bound disk use and the number of people on their server, and for those
who open a server to strangers as a demo. "Restricted mode" is a set of optional settings: limits on accounts,
owned workspaces, members, pages, file size, storage and versions, and on the server's workspaces and sign-ups per
hour; a storage fuse for the whole server; features turned off on the whole server;
sign-up with an ID and a nickname instead of an email address; terms and consent at sign-up; accounts deleted some
days after sign-up; a label such as "Demo" on every screen. A server that sets none of them behaves as 0.21.1,
except for what is listed under "What changes on every server" below.
One database migration, additive
(0062_limits_accounts; a 0.21 database goes from 62 to 63 applied migrations). No new dependency. The MCP tool list
and the server instructions are unchanged; tool errors for the new codes say what to do next. Design notes are
docs/adr/2500-* .. 2539-; 2530- .. 2539-* are the fixes of an independent security review before release (below).
A preset for a demo server is in deploy/demo/, run through deploy/demo/demo.sh, with the
steps in docs/DEMO.md; the settings reference is docs/OPERATIONS.md, section 17. The preset and
the steps for a public demo are included, but do not open a public demo for strangers with 0.22.0
: the review
found problems for a demo that shares a machine with other services, to be fixed in 0.22.1 (docs/KNOWN-ISSUES.md,
"Added in 0.22.0").

Not tried in Safari, Firefox or on a real phone (docs/KNOWN-ISSUES.md, "Added in 0.22.0").

What changes on every server

These change with no new setting, on every server that upgrades:

  • Every account can delete itself (Settings → Account → Delete account, DELETE /api/me), from a browser
    session, with the current password (and two-step code), or within ten minutes of signing in for delegated and
    OIDC accounts. It is immediate and cannot be undone: workspaces where the person is the only member, and
    deleted workspaces they own alone that could still be restored, are deleted with their files; a shared workspace
    they own alone passes to its oldest admin-role member, else its oldest member;
    their private pages are deleted, and their shared pages, comments and versions stay without their name. The only
    admin cannot (409 LAST_ADMIN). Backups keep the data until they rotate out.
  • A sole owner who is the workspace's only member can leave it, and the workspace is deleted at once with its
    pages and files (no restore), after typing its name. Before, leaving was refused (400). A sole owner with other
    members is still refused: transfer ownership first. Tabs still open on the deleted pages, page guests' included,
    are disconnected (docs/adr/2529-*).
  • An owner can delete a deleted workspace for good at once ("Delete now" in Settings → Account → Deleted
    workspaces, DELETE /api/workspaces/:id/permanent), instead of waiting for the end of its restore window.
  • Housekeeping deletes ip_bans rows whose ban ended more than 30 days ago. An active ban is never touched.
    Before, nothing deleted them (KNOWN-ISSUES B-L7).
  • The admin's account deletion runs through the same deletion code as leaving and expiry. What it does and
    answers is unchanged (409 SOLE_OWNER while the person is a sole owner, private pages to the trash, the signup
    key's use given back).
  • The first account to sign up on a server without an admin is made admin inside the sign-up transaction, under
    the admin lock, instead of right after it. The old call after the commit stays and does nothing then. The rule is
    the same: with no admin, the first sign-up becomes the admin.
  • Workspace settings → General shows the workspace's usage: members, pages (the trash included) and storage. The
    server counts the storage again when the stored count is more than a minute old, so at most once a minute per
    workspace, also without limits (docs/PERFORMANCE.md).
  • Admin → Server status shows a new "Account cap" item under the security settings while anyone can sign up
    (SIGNUP_REQUIRE_KEY=0); in production it is amber until SIGNUP_MAX_USERS is set.
  • A new notification, "You are now the owner of …: its previous owner deleted their account". The hourly
    housekeeping also deletes sign-up address records older than 30 days (there are none without
    SIGNUP_PER_IP_PER_DAY).
  • The request rate limit counts an IPv6 client by its /64 instead of its full address, so one subscriber's
    addresses share one budget (docs/adr/2537-*). IPv4 is unchanged; the sign-in failure bans are unchanged.
  • Account deletion and expiry find the copied names by the account's id only (docs/adr/2535-*): the audit rows
    it acted in or was the target of, the names write sites keep beside an id, and the workspace it made at sign-up.
    Records of another person with the same name are not changed. A name written without an id beside it stays: the
    person of the page access rows and the invited address of page invitations, also in rows this release writes, and
    in older rows the names of locking a page, changing a lock's editors, and blocking and unblocking an agent
    (KNOWN-ISSUES LIMITS-8; to be removed in 0.22.1).
  • Audit JSON keeps ids beside names: page.locked and page.lock_editors_changed store editorIds,
    agent.blocked and agent.unblocked store userId. The audit screen and route do not show them.
  • The deletion preview (GET /api/me/delete-preview) answers browser sessions only: a token gets 403. The
    preview is new in this release, so nothing that worked before stops working.
  • The OAuth token exchange is one transaction: consuming the authorization code and storing the grant commit
    together. The answers are unchanged.

Added

  • Limits (docs/adr/2505-, 2506-): LIMIT_WORKSPACES_PER_USER (owned workspaces, deleted ones still restorable
    included), LIMIT_MEMBERS_PER_WORKSPACE (page guests do not count), LIMIT_PAGES_PER_WORKSPACE (the trash
    included), LIMIT_FILE_MB (one upload, at most 25; connections get the smaller of it and AGENT_UPLOAD_MAX_MB),
    LIMIT_WORKSPACE_STORAGE_MB and LIMIT_VERSIONS_PER_PAGE (1–50). Checked in the transaction that creates the
    row (transfer of ownership and restore included, docs/adr/2528-*), under a lock, on every path that creates pages, files, members or workspaces (REST and the MCP tools that
    call it); a test lists every insert site and fails on a new unchecked one. Errors 403 LIMIT_WORKSPACES,
    LIMIT_MEMBERS, LIMIT_PAGES and 413 LIMIT_STORAGE, LIMIT_FILE, each with { limit, used }.
  • Storage and read-only workspaces (docs/adr/2506-, 2530-, 2533-*): storage counts files, page bodies, version
    history, handwriting, comments, page rows, database fields and views, templates, the change log's texts and agent
    suggestions, the trash included. A workspace that has reached its limit is read-only: every write that can grow
    it is refused (a test lists every POST, PUT and PATCH route as checked or open with its reason), live edits are
    counted when they arrive and one that does not fit is not stored, live editing turns read-only, and a notice says
    what to delete. Deleting,
    emptying the trash and exporting always work. When a count finds the workspace back under its limit, open editors
    reconnect and can edit again. One page body may hold at most a quarter of the limit.
  • Features turned off (docs/adr/2507-*): DISABLED_FEATURES takes public-links, public-forms, webhooks,
    slack, link-preview, web-clipper, ical, notion-import, web-push, password-reset, email-invites,
    automations-webhooks, oauth-cimd, embeds and member-direct-add. Their routes answer 404 FEATURE_DISABLED,
    what exists stops working without being deleted, clean-up stays possible, and the app hides their menus.
  • Sign-in IDs and sign-up limits (docs/adr/2512-, 2516-): LOGIN_ID_MODE=username (an ID and a nickname
    instead of an email; needs mail, OIDC and delegated sign-in off and password-reset turned off),
    SIGNUP_MAX_USERS (403 SIGNUP_FULL), SIGNUP_PER_IP_PER_DAY (429 SIGNUP_IP_LIMIT), and with either cap (or
    SIGNUP_PER_HOUR) a hidden
    field and a two-second minimum on the form (400 SIGNUP_CHECK_FAILED). On a restricted server without an admin,
    sign-up without the setup code is refused (403 SETUP_REQUIRED, docs/adr/2527-*) and the sign-up screen says it
    waits for its operator, so a stranger cannot become the first admin by signing up.
  • Terms and consent (docs/adr/2519-, 2520-): LEGAL_DIR holds the terms, the privacy policy and signup.json
    (the notice and the tick boxes). Each ticked item is stored with the document version (a hash of the files). /terms and
    /privacy open without signing in. Accounts without consent to the current version, including everyone after the
    texts change, see a consent screen and are refused on every way in (browser, API tokens, MCP, the collaboration
    socket) with 403 CONSENT_REQUIRED until they agree, sign out or delete their account (the consent screen has
    Delete my account, without export). The documents are Markdown drawn without any HTML.
  • Instance label and notice (docs/adr/2520-, 2526-): INSTANCE_LABEL (up to 20 characters) on every screen,
    phones included. INSTANCE_NOTICE (up to 500 characters of plain text, line breaks kept, no links) under the title
    of the sign-in, sign-up, consent and setup-waiting screens and as a strip above every app screen; nobody can close
    it, and it changes with a restart.
  • Account lifetime (docs/adr/2515-*): ACCOUNT_LIFETIME_DAYS deletes accounts that signed up while it was set,
    N days after sign-up, never admins and never accounts from before it; ACCOUNT_LIFETIME_DRY_RUN=1 only logs. The
    date is shown in the app with a...
Read more

v0.21.1

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 08:50

A patch release for a security advisory in the server's multipart parser, with a group of patch updates and a
browser check of the PDF preview's error boundary. No database migration, no new environment variable, no new
dependency, no API change: the four upload routes keep their limits and answers, and a cut upload now gets a 400.

Security

  • @fastify/multipart 9.4.0 → 10.1.8 (GHSA-5849-5m6q-9632, medium; every version from 5.3.0 before 10.1.7, no
    9.x fix). A multipart body that ended inside a file part, without the closing boundary, had its file stream
    destroyed without an error, so a handler that read that stream could wait forever and each such request held its
    connection and handler (a denial of service when many are sent). Only signed-in accounts reached our multipart
    routes: the body is read after the sign-in (session or API token) and workspace checks, and file uploads by a guest
    only into a page shared with them that they can edit. Against 9.4.0, a small cut part left POST /api/files,
    POST /api/workspaces/:id/import and POST /api/workspaces/:id/import-folder without an answer; a larger cut
    part, and any cut part on POST /api/workspaces/:id/templates/import, answered 500 instead. With 10.1.8 the parser
    reports the cut body, and all four routes answer 400 VALIDATION ("The upload ended before the file was complete;
    send it again") at once. Size limits and the 413 PAYLOAD_TOO_LARGE answers are unchanged.

Dependencies

  • @fastify/multipart 10.1.8 (pinned, see Security; it brings fastify-plugin 6, already in the tree).
  • Patch updates (Dependabot group "runtime-patches"): jszip 3.10.2 (server, CLI), @fastify/cookie 11.1.5, yjs
    13.6.33 (server and web, still one copy shared with Hocuspocus and BlockNote), d3-force 3.0.1. The editor pins
    (@blocknote/* 0.51.4, prosemirror-view 1.42.4, pdfjs-dist 6.5.438) are unchanged.

Tests

  • multipartTruncated.db.test.ts sends bodies cut inside a file part to every multipart route (file upload, import,
    folder import with the first or a later part cut, template import; small and 512 KB parts) over a real socket and
    expects a 4xx within 5 seconds, then a complete upload that still works. Against 9.4.0 it fails: three routes hang
    and the rest answer 500.
  • The PDF preview's per-block error boundary was made to throw in Chrome 157 against the production build, on the
    first render of one preview and on a later render of another (KNOWN-ISSUES PDFVIEW-12): only that block turned
    into "The preview could not open this PDF." with its download link (which serves the file), the PDF beside it kept
    drawing, the app's crash screen never showed, and the editor kept taking typing. No defect was found.

v0.21.0

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 08:10

A minor release with one feature: a PDF attached to a page now shows its pages in the page, under the file name.
Web app only: no database migration (a 0.20 database stays at 62 applied migrations), no new setting, no header
change, no API change, and the stored file block, its HTML export and the document format are unchanged. New
dependency pdfjs-dist 6.5.438 (Apache-2.0, web only, loaded on the first PDF preview of a session, not precached).
The app uses pdf.js's legacy build, which carries polyfills for browsers without the newest built-ins; pdf.js
supports it in Firefox ESR, Chrome 125+ (Edge, Opera) and "mostly" Safari 18+. Its optional Node canvas
(@napi-rs/canvas) is not installed (ignoredOptionalDependencies in pnpm-workspace.yaml). The build now ships
pdf.js's licence and its data files with their licences; they are listed in
THIRD-PARTY-NOTICES.md. The MCP tool list is unchanged.

Checked in Chrome 157 only (desktop and a 390 px touch window, light and dark, and with the newest built-ins removed
on the page to exercise the legacy build's polyfills; the polyfills inside the worker were not exercised); not
tried in Safari, Firefox, Samsung Internet or on a real phone. The wasm image decoders (JPEG 2000, JBIG2, colour
profiles) compile in the worker, but no scanned PDF was decoded in the check
(docs/KNOWN-ISSUES.md, "Added in 0.21.0").

Upgrade notes

  • Nothing to do on the server: no migration, no setting, no header change. Reload open tabs to get the preview.
  • A page with a PDF asks for its ink strokes (GET /api/pages/:id/ink) when it opens and again every 60 s while it
    is open with pen mode off, because the preview is not shown on pages with ink (below) and the server does not
    announce ink changes.
  • The service worker keeps pdf.js's files in a cache of their own, inkling-pdfjs (60 entries, 30 days), next to
    inkling-lazy-assets. Neither is in the precache.
  • Proxies: the preview loads pdf.js, its worker (a .mjs file) and its data files from /assets/lazy/. A
    reverse proxy that blocks or rewrites those paths stops the preview: it shows "The preview could not be loaded."
    with a download link. A proxy that serves .mjs with a type other than JavaScript also stops it, with an error
    message and the download link (docs/OPERATIONS.md, "PDF preview (0.21)").

Added

  • PDF preview in the page (docs/adr/2480-* .. 2483-*). A PDF attached to a page (a file block whose file was
    uploaded to this server) shows its pages under the file name. The pages scroll inside an area at most 70% of the
    screen tall; type a page number to jump, zoom in steps (25–400%) or fit the width, open it full screen (Esc or the
    close button closes it), select and copy its text, and follow its web links (they open in a new tab; a link to
    another page of the same PDF scrolls the preview there). Files up to 10 MB load when the block comes near the
    screen; larger ones, and every file in a browser with the data saver on, show "Load preview (25.1 MB)" and load on
    a press, with a progress bar; a download that does not move for 30 s ends in "The file stopped loading." with
    "Try again". "Hide preview" is remembered per person and file in this browser. Works in editable and locked
    pages. In pen mode and on a page that has ink strokes there is no preview (PDFs show their name line as in 0.20),
    because ink is placed by the body's height; another member's first stroke hides an open tab's preview within a
    minute. Printing and "Export as PDF" keep the file name line only. A preview far from the screen lets go of its
    canvases and, after 10 s, of its document, and loads it again at the same page and zoom when you come back. The
    preview is view state: nothing is stored in the document, and a member who deletes or replaces the file block
    removes or replaces the preview in everyone's tab. Each person reads at their own page.

Security

  • PDFs are still never opened by the browser itself: /files/:id keeps Content-Disposition: attachment,
    nosniff and its sandbox CSP. The preview draws them with pdf.js from the app's own origin (no CDN), runs no
    JavaScript from the PDF, has no form fields, attachments or launch actions, and keeps only http:/https: links
    (opened with noopener noreferrer). Password-protected and broken PDFs show a message and the download link; the
    preview never asks for a password. The app's CSP is unchanged (docs/adr/2480-*).
  • Limits keep a hostile or huge PDF inside its own block (docs/adr/2483-*): at most 5,000 pages (more shows "This
    PDF has too many pages (N) to preview here." with the download link), a page box of at most 5,000 CSS px on its
    long side at 100%, one page canvas of at most 8,388,608 pixels and 8,192 px a side, at most 8 pages drawn per
    pass, and no image over 2^26 pixels. An error inside a preview turns only that block into an error message; the
    page and the editor go on.

Performance

  • The entry chunk is unchanged (449,412 → 449,394 B, build-id noise); entry plus modulepreload +3,701 B (+924 B
    gzip, the preview's strings among them), the editor chunk +5,142 B (+1,639 B gzip), the entry stylesheet +1,281 B.
    The preview UI (PdfPreview-*.js, 23,532 B, 8,331 B gzip, + 2,966 B CSS) is precached and loads when a PDF block
    comes near the screen; pdf.js (501,358 B, 150,974 B gzip) and its worker (1,327,591 B, 394,383 B gzip) when a
    preview loads a file; cMaps and fonts per need. None of pdf.js is in the PWA precache. Pages without a PDF fetch
    none of it (docs/PERFORMANCE.md).
  • A 5,000-page PDF: page 1 drawn 0.88 s after opening, a jump to page 5,000 drawn in 75 ms, 27 MB of JS heap. A
    page with 12 PDFs scrolled to the end holds 1 open document and 2 canvases 28 s later (docs/adr/2483-*,
    docs/PERFORMANCE.md).
  • Page 1 waits for the whole file, because /files/:id sends no byte ranges: about 4.2 s for 10 MB and 10.2 s for
    25 MB at 20 Mbit/s. The auto-load limit is 10 MB instead of the proposed 15 MB for that reason
    (docs/adr/2482-*, docs/PERFORMANCE.md).

v0.20.0

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 07:07

Reload open tabs after the upgrade. A tab that still runs 0.19 or older cannot show columns, and its editor
would delete a group of columns with everything inside it. 0.20 lets such a tab read pages with columns but not
edit them, until it is reloaded (below and docs/adr/2425-*).

A minor release with columns, charts on public links and better find_context answers for Korean questions. Blocks can sit side by side in
two to four columns (/2단, /3단); agents, Markdown downloads, zip export and vault sync carry them as comment
markers. A tab of an older release can no longer delete them: each client tells the server which document schema it
knows, and the server takes edits only from clients that know every node on the page. find_context counts the
shorter form of a long Korean word in titles and headings, prefers sections with the question's rarest word and
gives title words their real weight. A public link can now show the page's charts, drawn as charts from labels and
numbers, once an owner or admin turns it on for that link; public pages also draw callouts (icon, then text) and
text and background colours as the editor does. One database migration, additive: 0061_share_include_charts (three
columns on pages; a 0.19 database goes from 61 to 62 applied migrations, and every existing link keeps charts off).
No new dependency, two optional settings (EMBEDDING_QUERY_PREFIX, EMBEDDING_PASSAGE_PREFIX). The MCP tool list keeps its 48 tools
(32 in core) and their descriptions; every tool now carries its annotation hints (+468 tokens full, +324 core). Upgrade matrix adds v0.19.0 and v0.19.1.

Checked in Chrome only (desktop and a 390 px window): the columns check (31 steps), a 0.19.1 build against the 0.20
server (10 steps), public charts (27 steps), public callouts and colours (16 steps) and the 0.19 browser checks passed; none of it was tried in Safari, Firefox or on a touch device
(docs/KNOWN-ISSUES.md, "Added in 0.20.0").

Upgrade notes

  • Tabs left open over the upgrade (docs/adr/2425-*). Pages without columns: nothing changes, a 0.19 tab edits
    them as before. Pages with columns: a 0.19 tab gets a read-only connection. It shows the page without the group,
    under its lock line ("Locked · … You can read and comment, but not edit": 0.19 reads a read-only connection as a
    lock), next to its own "A new version is available. Reload" notice; typing does nothing and nothing it does
    reaches the page. When someone adds columns to a page a 0.19 tab has open, that tab turns read-only the same way
    within a moment; what it sent in that moment is dropped. After Reload the tab runs 0.20 and edits normally. A 0.19
    tab with offline copies on (the installed app) keeps its editor's deletion of the group as an unsent edit; 0.20
    keeps that edit as a recovery item ("Made by an older version of the app") instead of sending it. A row template
    body with columns refuses saves from a 0.19 tab (409 SCHEMA_OUTDATED).
  • Proxies: the collaboration socket URL now carries a query string (/collab?schema=2). Path rules such as
    Caddy's or nginx's location /collab need nothing; a rule that compares the whole request URI must allow it. A
    proxy that strips the query makes every 0.20 tab look like 0.19: read-only on pages with columns.
  • Migration 0061 (the only one) adds pages.share_include_charts (boolean, default false), pages.share_charts_by
    (uuid, references users, on delete set null) and pages.share_chart_sources (jsonb, the approved chart sources).
    Additive; every existing link keeps its behaviour (charts off) until a manager turns them on in the share dialog.
    Chart numbers on public pages can be up to 10 minutes old (the public render cache); the switch and the person's
    membership apply at once.
  • No re-index: the new find_context rules work at query time. Answers to Korean questions can be ordered
    differently from 0.19; answers cached in memory are dropped by the restart.
  • Going back to 0.19.1 should need no database restore: 0.19 does not read the three new columns (0061 stays
    applied); starting 0.19.1 on a database with 0061 was not tried. But
    0.19 does not know columns and has no guard: its editor deletes a group with its content as soon as someone opens
    the page; do not go back once columns are in use. A page whose link showed charts, published again while 0.19
    runs, keeps the chart setting on for its new link once 0.20 runs again (KNOWN-ISSUES SHARE-9). Not checked beyond
    that.
  • Semantic search: EMBEDDING_QUERY_PREFIX and EMBEDDING_PASSAGE_PREFIX are empty by default, so nothing
    changes. Setting, changing or removing one re-embeds every section at EMBEDDING_REQUESTS_PER_MINUTE; until that
    finishes, sections without a new vector are found by their words only (docs/OPERATIONS.md).
  • API: GET /api/pages/:id/sync-check?schema=N (new query) answers needs when N is below the server's document
    schema; PATCH /api/collection-row-templates/:id takes schema (409 SCHEMA_OUTDATED); page bodies with columns
    carry <!-- inkling:columns --> marker lines in every Markdown format; PATCH /api/pages/:id/share takes
    includeCharts and approveChartSources, ShareStatusDTO and PublicPageDTO gain chart fields (docs/API.md,
    "v0.20.0 additions").

Added

  • Columns (docs/adr/2420-* .. 2424-*). Put blocks side by side: /2단 or /3단 in the slash menu (English "2
    columns", "3 columns"; /columns and /단 find them too) turns an empty line into a group of empty columns with
    the caret in the first one (on a line with text the group goes below it). Any ordinary block goes in a column:
    text, headings, lists, to-dos, images, code, callouts, toggles, tables, embeds. Drag the boundary between two
    columns to change their widths (each keeps at least 15%), double-click it to make them equal. The block menu (⋮⋮)
    of a block in a column adds Add column (up to four), Delete this column (its blocks move to the column on
    its left) and Unwrap columns (everything back as ordinary blocks, in order). Nothing tidies a group on its
    own: an empty column stays until you delete it; Backspace in a group whose columns are all empty removes it.
    Below 640 px of width (phones, a side peek) the columns stack in order. Public links, presentation mode, PDF and
    print, page embeds and the offline copy show the columns, and the image viewer opens on images inside them;
    agents, Markdown downloads, zip export/import and vault sync write them as <!-- inkling:columns --> /
    <!-- inkling:column --> / <!-- /inkling:columns --> lines. A heading inside a column is not a section.
    Written against @blocknote/core's public API; BlockNote's GPL multi-column package is not used. No new
    dependency.
  • Charts on public links (docs/adr/2440-* .. 2444-*). A public link can now show the page's charts: the share
    dialog says "N charts on this page do not show on the public link" and offers Show charts on the public page
    (owners and admins; off by default, per link, audited). When it is on, each chart's labels and numbers are
    published — worked out with the access of the person who turned it on, while they are a member of the workspace,
    and only for the databases and queries the charts used when it was turned on (a chart added later over another
    database waits: "N newly added charts are not public yet", Publish these charts too) — never the rows behind
    them, the database's or view's name, or any id or query text. Public pages draw charts with the app's own chart
    component (also in presentation mode, print and "Save as PDF"; scaled to the paper), with the table underneath for
    screen readers, readers without scripts and the Markdown download. A chart inside a column stands in that column
    (its title and table too). The chart code loads only on pages that have a chart. Without the switch, a folder
    link's charts of its own databases are now drawn as charts instead of tables; everything else is as before.
  • Document schema version (docs/adr/2425-*). Every client says on its collaboration socket which document
    schema it knows (0.20 = 2; none = 0.19 and older = 1). On a page that holds a node type the client does not
    know, its connection is read-only, from the start or from the moment such a node arrives, so an older editor
    never deletes what it cannot show. 0.20 shows "This page has content that only a newer version of the app can
    edit. Reload to update." when that happens to it in a later release.
  • Role prefixes for embedding models: EMBEDDING_QUERY_PREFIX and EMBEDDING_PASSAGE_PREFIX (optional, empty
    by default) for models that expect them, such as the e5 family ("query: ", "passage: "). Changing either one
    re-embeds every section, as a model change does (docs/adr/2404-*).
  • Developers: a recall evaluation set for find_context (32 questions written the way people remember pages, over
    three workspaces) with page@1, page@3 and page MRR in apps/server/scripts/context-bench.ts and
    context-tune.ts (docs/adr/2400-*).
  • Korean guides: deploy/DEPLOY.ko.md, docs/OPERATIONS.ko.md, docs/BACKUP.ko.md, docs/MCP.ko.md,
    docs/QUERY.ko.md, docs/TEMPLATES.ko.md, docs/ARCHITECTURE.ko.md, docs/WEBHOOKS.ko.md, docs/VAULT-SYNC.ko.md,
    docs/PLUGINS.ko.md, docs/API.ko.md, docs/KNOWN-ISSUES.ko.md, docs/PERFORMANCE.ko.md and docs/ROADMAP.ko.md,
    with the same sections, anchors and code blocks as the English files. The Korean README and user guide link to them;
    each English file links to its Korean one.

Changed

  • find_context finds pages people describe with a longer word than the page uses (docs/adr/2401-* .. 2403-*):
    a Korean query word of three or more syllables also counts, with a discount, when its shorter form (the word
    without the last syllable, e.g. 택배함 → 택배, 회의록 → 회의) is in a page title or heading. Sections that miss the
    question's clea...
Read more

v0.19.1

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 06:40

A patch release in two parts. The onboarding intro, redone after it was seen in production, is drawn with real
content, a camera and ink wipes, ends on a screen of next steps (sample page, New page, Connect an AI agent) instead
of closing, and no longer says "open source". Pictures in a page and on public links open large in a new image
viewer. Web app only: no database migration, no new environment variable, no new dependency, no API change; the
stored image block, its HTML export and the server schema are unchanged.

Added

  • Image viewer (docs/adr/2386-*). Pictures in a page open large over a dark backdrop: double-click an image in
    the editor or press the magnifier button in its corner (always shown on touch screens); on a page that is
    read-only for you and on public links one click opens it (on a public link an image inside a link follows the
    link). Zoom with the wheel, a trackpad or a two-finger pinch (about the pointer), +/-, 0 to fit and a
    double-click for 100% (a small image is never enlarged past 100% to fit); drag to move. ←/→ and the side buttons
    go through the page's images ("2 / 5"); the top bar shows the caption or file name, the zoom and "Open original"
    (new tab). Esc, a click on the backdrop or the close button returns to where you were; the browser's Back leaves
    the page as before and closes the viewer with it, so it never stays over another screen. Keys
    typed while it is open never reach the page (⌘/Ctrl/Alt combinations stay the browser's). A one-click open in the
    editor was left out on purpose: a click still selects the image block for its toolbar, resize handles and drag.
    The shortcut help (?) lists the viewer's keys in a new group, Image viewer. There is no keyboard way to open it
    (KNOWN-ISSUES ZOOM-3).

Changed

  • The intro shows the real thing and moves like it (docs/adr/2385-*). The four scenes are now drawn with real
    content instead of grey bars: two people writing on a "Weekly sync" page with named cursors, a [[link]] to a second
    page with its backlink, and the database view inside the page turning from a table into a board; an AI agent asking
    find_context and getting back just the two sections it needs (cited as Page › Heading); the agent suggesting a
    section change that a person reviews and accepts (the "Before AI edit" point and Revert), then update_row moving a
    board card; your own
    server syncing a laptop and a phone, going offline and back. A camera pushes in on what matters and pulls back out,
    scenes change with an ink wipe from where the drop lands, and the drop has eyes, hops, squashes and leaves a short
    tail. The picture takes about two thirds of the dialog; on a phone the camera shows a close part of each scene so
    the words in it stay readable. Still 26 seconds, still pictures with reduced motion.
  • The intro ends on next steps instead of closing. After the last scene (or the last still) it stops on the logo
    with "Ready to write?" and buttons: open or make the sample page (new accounts), New page, Connect an AI agent
    (Settings › Connections), Close. Accounts shown the intro with ONBOARDING_EXISTING_USERS=once are not offered the
    sample. A button closes the intro (it counts as seen) and then does what it says; → stays, ← goes back to the last
    scene, Esc closes.
  • The intro no longer says "open source"; scene 4 now reads "It runs on your own server. Turn on offline copies and
    pages keep opening without a connection."

Performance

  • The intro's lazy chunk is 34.94 kB (13.57 kB gzip) instead of 20.63 kB (7.51 kB gzip), still loaded only when it
    plays and not precached. Entry index-*.js 447,094 → 447,032 B (122,916 → 122,962 B gzip); entry plus modulepreload
    1,368,719 → 1,371,693 B (403,057 → 403,152 B gzip, the longer intro copy in the i18n chunk); precache 104 entries,
    +2,295 B (docs/PERFORMANCE.md).
  • The image viewer is a separate chunk loaded on its first open, 9,655 B (3,550 B gzip) plus 448 B of CSS; the entry
    script is unchanged in size (447,123 → 447,131 B against 958a9b4), the strings and shortcut rows add about 0.5 kB
    gzip to the preloaded i18n chunk. No new dependency (docs/PERFORMANCE.md).

v0.19.0

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 06:01

Before you upgrade a server that ran 0.18 or older: add one line to .env.
0.19 renames the compose project, volumes, database role and database from the old project name nodian to
inkling, and takes the names from a new required setting, INKLING_DATA_NAME. Put
INKLING_DATA_NAME=nodian in .env before docker compose up (for example
printf '\nINKLING_DATA_NAME=nodian\n' >> .env) and nothing else changes: the same containers, volumes and
data. Without the line compose refuses to start (and leaves the running stack alone); do not answer that by
setting inkling on an existing server, which starts an empty instance next to your data. Moving to the new
names is optional and can wait: ./deploy/rename-from-nodian.sh --dry-run, then without --dry-run (copies the
volumes, keeps the old ones, --rollback at any point). Local trials started with ./deploy/local.sh need
nothing. Details: docs/OPERATIONS.md.

A minor release that moves the data plumbing from the project's old name to inkling, gives public links a toolbar
(wide view, Save as PDF and a Markdown download the link's owner can turn on), fixes the app's PDF export and the
sidebar's "More", shows a notice with a Reload button where a screen used to stay white, and greets new accounts
with a short intro, a Getting started card and a sample page. Two database migrations, both additive:
0059_share_allow_download (pages.share_allow_download) and 0060_onboarding (user_onboarding, one row per
existing account). A 0.18 database goes from 59 to 61 applied migrations. No new dependency. One new setting,
INKLING_DATA_NAME, required and without a default (see above); two optional ones, ONBOARDING and
ONBOARDING_EXISTING_USERS. The MCP tool list is unchanged (48 tools, 32 in core). Upgrade matrix adds v0.18.0,
and a new rename job upgrades and renames installs from v0.17.1 and v0.18.0 (.github/workflows/upgrade.yml).

Checked in Chrome only (desktop and a 390 px window): the public page toolbar, its PDF, the app's PDF export, the
sidebar, the start-up notices, the intro and the Getting started card were not tried in Safari, Firefox or on a touch device. The rename job has not
run on GitHub Actions yet; the same script passed locally from v0.17.1 and from v0.18.0 (docs/KNOWN-ISSUES.md,
"Added in 0.19.0").

Upgrade notes

  • The order on a server from 0.18 or older: the upgrade first, on the old names; the rename later, if at all,
    after the upgrade is checked, so a migration and a rename never happen in one go.

    ./deploy/backup.sh
    printf '\nINKLING_DATA_NAME=nodian\n' >> .env     # 1. keep the old names
    git pull && docker compose pull app && docker compose up -d
    ./deploy/rename-from-nodian.sh --dry-run       # 2. optional, later: plan, sizes, free disk, downtime
    ./deploy/rename-from-nodian.sh                 #    the rename (asks once; --rollback at any point)

    Without the line every compose command stops with "required variable INKLING_DATA_NAME is missing a value";
    nothing was created or stopped. New installs copy .env.example (inkling). Keeping the old names is supported
    at least until 1.0 (docs/adr/2340-, 2341-).

  • Set inkling on an old server by mistake: compose starts an empty inkling project next to the untouched old
    volumes. Put INKLING_DATA_NAME=nodian back, docker compose -p inkling down, docker compose up -d, and delete
    the empty inkling_inkling-* volumes.

  • Servers that run Docker through sudo: run the rename script the way you run compose,
    sudo ./deploy/rename-from-nodian.sh --dry-run. It writes .env in place (owner and mode kept) and its state
    under ./backups/rename-nodian-to-inkling/ (root-owned when run with sudo).

  • An override that names old volume keys (nodian-data:/…) must use the new keys (data, db, backups,
    backup-ctl, rclone-bin); compose reports "undefined volume" until then.

  • After the rename, containers are inkling-app-1, inkling-db-1, inkling-backup-1: cron lines that name
    nodian-* containers need the new names. POSTGRES_USER/POSTGRES_DB lines in .env are not read (they never
    were); delete them.

  • Migration 0059 adds pages.share_allow_download boolean not null default false (a constant default:
    metadata-only, no backfill, milliseconds). Existing links keep the download off. Going back to 0.18.0 after the
    upgrade needed no restore in a check before onboarding was merged: the v0.18.0 image started on a database
    migrated to 60 rows (0059 only), served a new share link and logged no error (a near-empty database, not a copy of
    production). With 0060's user_onboarding table this was not checked again (KNOWN-ISSUES ONBOARD-5). A link that allowed downloads,
    unpublished and published again while 0.18.0 runs, keeps the setting and offers the download again once 0.19 runs
    (KNOWN-ISSUES SHARE-5).

  • Migration 0060 adds user_onboarding and gives every existing account a row {"legacy": true} (one
    INSERT…SELECT over users): people who already use Inkling are not shown the intro or the checklist after the
    upgrade. They can open both from Settings › About (docs/adr/2380-*).

  • New optional variables ONBOARDING (empty = on, off = no intro, card or sample page for anyone) and
    ONBOARDING_EXISTING_USERS (once = accounts from before the upgrade also see the intro once, on their next app
    load; closing or skipping it is stored per person, so it does not come back after restarts, and unsetting the
    variable later changes nothing for those who saw it; their checklist stays off and no sample page is made for
    them). Accounts first seen while ONBOARDING=off count as existing accounts if it is turned on later. Both are
    passed through by compose.yaml; recreate the container after changing them (docs/adr/2383-*), then check that
    the value arrived: docker compose exec app printenv ONBOARDING_EXISTING_USERS prints once (an empty line means
    unset). With once, an existing account that closes the tab while the intro is still playing (without Skip, Esc
    or reaching the end) sees it again on its next app load; it counts as seen only once it is closed or finished.
    Guests never get the intro.

  • Templates with a database and an inline view of it: a custom template that contains a database and an
    inline view (page embed) of that database now gives each new copy a view of its own copy; before, the view pointed
    at the original database. This applies to "Start from template" in the app and to POST /api/pages/from-template
    (the MCP create_from_template tool uses it); embeds of pages outside the template are kept as before
    (docs/adr/2381-*).

  • Markdown downloads of public pages link images and files with PUBLIC_URL (APP_URL as fallback). Set it in
    production; without it the request host is used, as for OAuth metadata.

  • PATCH /api/pages/:id/share accepts allowDownload: boolean; POST /api/pages/:id/share does not (strict body:
    400 if sent). New audit action share.download_changed (before/after { allowDownload }).

  • Developers: the dev database moves to inkling-db-1 on the same port 55432; stop an old nodian-db-1 first and
    drop a nodian DATABASE_URL from your .env (CONTRIBUTING.md).

Added

  • deploy/rename-from-nodian.sh (--dry-run, --yes, --rollback) moves an install to the new names:
    pre-rename backup (sidecar, or pg_dump when there is none), row counts, a copy of every volume whose name
    changes (the old ones are only read and never deleted), the role and database renamed inside the copy (the
    password set again from .env, which covers MD5), .env switched, then health, counts, files and a backup
    checked under the new names. It continues where an interrupted run stopped, and --rollback starts the old
    names again from any point. Downtime about a minute for a small server; needs free disk for a copy of the
    volumes (docs/adr/2341-*).
  • Rename test: scripts/upgrade-test/rename.sh and a rename job in .github/workflows/upgrade.yml (from
    v0.17.1 and v0.18.0, by commit): an old release installed like a server, the upgrade refused without the new
    line, the new release on the old names with its migrations (the journal may only grow), the rename (also
    killed after the copy and after the role rename, and rolled back) leaving the journal as it was, and a new
    install with no old name anywhere (docs/adr/2342-*).
  • Public links: Wide view. Pages follow their own "Full width" setting by default; a visitor's choice is
    remembered in their browser. Tables, code, diagrams and the tables of charts, database views and query results
    use the whole window; running text stops at a readable width (docs/adr/2360-*).
  • Public links: Save as PDF opens the browser's print dialog with the page title as the file name. The
    printout is the article alone, always in the light palette, with wide tables wrapped to the paper, code wrapped,
    toggles open, diagrams, formulas, images and checkboxes, without buttons or the folder list; the browser's own
    Print command gives the same result (docs/adr/2361-*).
  • Public links: Download Markdown, per link and off by default. People who manage links turn it on in the
    share dialog ("Let visitors download it as Markdown"); the file holds only what the public page shows
    (docs/adr/2362-*). Changes are in the audit log as "Public link download changed".
  • Public page actions fold into one "⋯" menu on narrow screens, with keyboard support (docs/adr/2363-*).
  • Onboarding for new accounts (docs/adr/2380-* .. 2382-*). A new account sees a 26-second intro once (notes and
    [[links]], databases and views, AI agents over MCP with suggestions and undo, your own server and offline), drawn
    in code, skippable, pausable, keyboard and screen-reader friendly...
Read more

v0.18.0

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 04:09

A minor release about writing from anywhere: offline copies of the pages you open, web push notifications to your
devices, a button block and database automations, a web clipper with an Android share target, workspace groups and
an archive of your own, and OAuth Client ID Metadata Documents for MCP clients (off by default, OAUTH_CIMD=1). Five
database migrations, all additive: 0054_w18_web_push (push subscriptions, settings and the VAPID key),
0055_w18_automations (rules and their runs), 0056_offline_doc_gen (pages.doc_gen), 0057_workspace_listings
(each person's workspace groups and archive) and 0058_row_number_tid (a new body for the row-number trigger
function). A 0.17 database goes from 54 to 59 applied migrations. No new dependency: web push encryption (RFC 8291)
and VAPID (RFC 8292) use node:crypto. New optional variables WEB_PUSH, VAPID_PUBLIC_KEY, VAPID_PRIVATE_KEY,
VAPID_SUBJECT, WEB_PUSH_ALLOWED_HOSTS, OAUTH_CIMD and OAUTH_CIMD_ALLOWED_HOSTS, passed through by
compose.yaml. The MCP tool list is unchanged (48 tools, 32 in core). Upgrade matrix adds v0.17.0 and v0.17.1
(.github/workflows/upgrade.yml).

Upgrade notes

  • Reload every tab and installed app before anyone uses a button block. A 0.17 client (an old tab, or an
    installed app that has not reloaded since the deploy) that edits a page with a button deletes the button: the
    0.17 editor does not know the block (as CHART-2 did for charts in 0.12). KNOWN-ISSUES AUTO-1.
  • Offline copies are on by default in the installed app and off in a browser tab. The installed app keeps
    every page opened after the update in the browser (IndexedDB inkling-offline); a browser tab keeps nothing until
    the person turns on Settings › Offline › "Keep offline copies on this device". Logging out, an expired or revoked
    session (any 401 UNAUTHORIZED) and another account signing in delete every copy on the device. Copies are not
    encrypted: on a shared computer leave the setting off (docs/adr/2203-). After restoring the database from a backup
    (deploy/restore.sh), devices that hold unsent edits newer than the backup keep them as recovery items
    (Settings › Offline › Recovery) instead of merging them (docs/adr/2201-
    ).
  • Web push needs HTTPS and outbound HTTPS from the server. Browsers allow push only on https:// origins (and
    http://localhost). The server sends pushes to the browsers' push services on port 443 (fcm.googleapis.com,
    *.push.services.mozilla.com, *.push.apple.com, *.notify.windows.com; docs/OPERATIONS.md section 12); an
    egress firewall must allow them. Nothing to configure otherwise: the server makes its VAPID key on first use and
    keeps it in the database (push_vapid_keys) unless VAPID_PUBLIC_KEY / VAPID_PRIVATE_KEY are set. Another
    key (a different database, such as another instance's or a fresh one; a deleted row; a changed env pair) voids
    every device's subscription; devices subscribe again when the person next opens the app. Set APP_SECRET_KEY so
    subscription endpoints and the generated private key are sealed at rest: a database restored under another
    APP_SECRET_KEY cannot read its key, and push stops until the original secret (kept off the server, outside the
    backups) is put back or the row is deleted, which makes a new key. For iPhone and iPad set VAPID_SUBJECT=mailto:… or an https
    PUBLIC_URL. WEB_PUSH=off switches push off server-wide (docs/adr/2220-*).
  • /push-sw.js is sent with Cache-Control: no-cache like /sw.js (the service worker imports it, and imports
    go through the HTTP cache on worker updates). A proxy or CDN must not override it.
  • Push subscriptions belong to the login session that made them. Logging out, a password change, an admin's
    revoke of sessions and the 30-day session expiry delete that device's subscription; the device is silent until the
    person opens the app and signs in there again (docs/adr/2221-*).
  • Automations run as the person who last saved (or turned on) the rule, capped by whoever triggered the run;
    their writes read <author> via automation: <rule>. Clients that read via as "an agent" meet these values in
    the feed, catch_up, webhooks and edited_via; they are not agent writes. page_props change-log events now carry
    keys (the changed property ids, at most 100); page_changes is unchanged. A 15-minute timer per server process
    queues "date reached" rules in the server's time zone (docs/adr/2240-* .. 2243-*).
  • OAuth client names that fold to a word starting with "automation" are refused at registration, at consent
    and for new agent connection tokens (CLIENT_NAME_RESERVED), like "public form", so no app can write as
    automation: …. Existing connections are not renamed.
  • The web clipper's "Article text" makes the server fetch the page (outbound HTTP(S) GET, ports 80/443, public
    addresses only, through the SSRF guard). On a server that blocks outbound traffic every article save becomes a
    link save with fallback: fetch_failed; the page is created either way. Bearer tokens may call POST /api/clip
    with mode: 'link' only (403 CLIP_ARTICLE_SESSION_ONLY). Images in a clipped article stay on the original site.
  • Archived workspaces leave agents' default searches. find_context, search and catch_up without workspaceId
    skip the workspaces the person archived and end with one line naming them (Not searched: … / Not included: …);
    workspaceId (an id or the name) reaches one. Nobody has archived anything right after the upgrade, so every
    answer is the same until someone does (docs/adr/2303-, 2304-).
  • Presentation mode splits slides differently. Slides now start at the shallowest heading level used two or more
    times, and at every heading above it. A page with one H1 at the top and H2 sections gets a slide per section
    instead of two slides in all; a page with several H1s splits as before (docs/adr/2323-*).
  • Menus at the caret open upwards (/, [[, ![[, @) when there are less than 300 px below the line and more
    room above, even for a short menu, and fit the visible part of the window (docs/adr/2322-*).
  • OAuth Client ID Metadata Documents are off. Nothing changes unless OAUTH_CIMD=1 is set; the authorization
    server metadata is identical while it is off. Turned on, Claude clients prefer it over dynamic registration for
    new connections; existing connections keep working. Turned off again, connections made through it stop at their
    next token refresh (within an hour) (docs/adr/2280-*).
  • Migration 0058 replaces the body of inkling_row_number() (the trigger function of 0051); no table, index or
    trigger definition changes. A row inserted while another transaction adds an ID property to its database may
    still stay without a number, as in 0.17 (KNOWN-ISSUES ROWNUM-1, not fixed in 0.18; docs/adr/2320-*).

Added

  • Offline copies on this device (docs/adr/2200-* .. 2204-*). Pages you open are kept in the browser (IndexedDB)
    so they open and can be edited without a connection; the edits are uploaded through the normal live sync when the
    connection is back. The app also starts offline from the last user, workspace list, workspace groups and page tree
    the server sent, with a banner saying so; the page list is read-only offline, and a page never opened on the
    device says so instead of showing an empty editor. Settings › Offline: "Keep offline copies on this device" (on by
    default in the installed app, off in a browser tab), how much is stored, "Delete now", and recovery items.
  • Document generation (pages.doc_gen, migration 0056): bumped after a version restore, an AI-edit revert, a
    split and a full-body rewrite. A device copy whose unsent edits are based on an older generation is not merged:
    the edits are kept as a recovery item (Settings › Offline › Recovery) and the page reopens from the server with a
    notice. The same happens when the page went to the trash or the edit right was lost while offline; with no access
    at all (member removed, page made private) the copy is deleted (docs/adr/2201-*).
  • Push notifications (web push) (docs/adr/2220-* .. 2223-*). Turn them on per device in Settings › Notifications
    › Push notifications; mentions, assignments, replies, comments, approvals and reminders then arrive with the app
    closed (installed app or a browser tab; iPhone and iPad from the Home Screen app, iOS 16.4+). Choose which kinds
    push, pause push on all devices, hide the content on the lock screen, see and remove your devices, send a test.
    Pushes follow your notifications (same recipients, levels and page visibility, checked again when sent), one per
    page at a time; the page you are looking at is not pinged twice. Automation notices push as mentions.
  • Button block (/button, docs/adr/2244-*): a label, a color and up to five actions run in order by whoever
    presses it: add a row to a database (template, values with today, today+N, me, this page, {{today}} /
    {{me}} / {{page}} in text), set values of the row the page is, open a page or an http(s) URL, send to a webhook
    a workspace owner registered. It shows progress, ignores a second press while running and says which action
    stopped and why. It runs through the REST routes the person may use anyway: a button adds no right. Public links
    and presentation mode show it disabled; print hides it; agents and downloads see <!-- inkling:button {…} -->;
    plain Markdown shows **[label]**; vault sync keeps the token.
  • Database automations (database menu › Automations, docs/adr/2240-* .. 2243-*): rules with a trigger (row
    added; a property changed, optionally "to a value"; a date property N days ahead), an optional condition (the view
    filter with any / all groups and NOT) and up to five actions (set values, assign a person, notify people, send to a
    registered webhook — Slack, Discord or gen...
Read more

v0.17.1

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 00:49

A patch release with three fixes found by clicking through 0.17.0 in Chrome. Web app only: no database migration,
no new dependency, no configuration change.

Fixed

  • A click on a page link in the editor no longer opens a second tab. [[Page]] and [[Page#Heading]] links moved
    the current tab and also opened the same page in a new tab, because BlockNote's link handler opened every link
    with window.open; ⌘-click moved the current tab as well. A plain click now moves in the app only, ⌘/Ctrl-click and
    the middle button open one new tab and leave the current one where it is, and external links open one new tab as
    before. The same holds in the row-template editor, in a page embed's body and in a page that is read-only for you
    (docs/adr/2107-*).
  • Presentation mode draws Mermaid diagrams. On a public link the slides showed the ```mermaid code; each slide now
    draws its diagrams with the public page's renderer (strict settings, an image), and in the app a diagram the
    editor had not drawn yet when the presentation opened is drawn on its slide too (docs/adr/2191-*). Code blocks on
    slides were white text on a light background and keep the editor's dark box now.
  • The view picker of a database view block works on the first click. Picking a view with the mouse (or, in an
    empty block, a database and a view) node-selected the block and kept the old value until a second pick. The editor
    no longer takes a mouse press inside a select as a click on its block (docs/adr/2108-*).

v0.17.0

Choose a tag to compare

@PROVE1352 PROVE1352 released this 12 Nov 00:11

A minor release about Notion- and Obsidian-style use and feedback from people running Inkling every day: Mermaid
diagrams, [[Page#Heading]] links to a section, database views inside pages, new database properties (email,
phone, created and edited time and by, IDs like TASK-12), filters with OR and NOT, sub-items and a list view,
an agent task board template, guests who can open the databases shared with them, a one-command local trial, MCP
import_zip, a version per agent write, and a ranked search. Three database migrations, all additive:
0051_v017_collection_rows (row numbers and the last editor of a collection row), 0052_page_link_sections (the
heading a page link points to) and 0053_v017_snapshot_steps (AI steps in the version history). A 0.16.0 database
goes from 51 to 54 applied migrations. New dependency mermaid 12.3.0 (web only, loaded on the first diagram, not
precached). Two new optional compose variables, INKLING_PORT and INKLING_DB_PORT. Upgrade matrix adds v0.16.0
(.github/workflows/upgrade.yml).

Upgrade notes

  • MCP search output and default count changed. One call now ranks every workspace together (title, then
    heading, then body; whole words before parts of words), groups answers from several workspaces under
    ## <name> (<id>), prints §anchor for heading and body matches and returns 10 results by default (before:
    20 per workspace, every workspace) with a closing line saying how many more matched and where. Pass limit
    (at most 50) or workspaceId for more. format: "json" keeps results[].id, workspaceId, title, kind,
    section and snippet and adds keys (docs/adr/2183-, 2184-).
  • Every agent write leaves a version ("AI step"). patch_section, patch_sections, update_page, restore_version
    and upload_file each store the page right after the write, labelled with the client, the sections and the lines
    changed; "Before AI edit" is stored only when the page changed since the newest version. Each client keeps its
    newest 20 steps per page and a page keeps at most 30 steps; the 50-version cap per page is unchanged and step rows
    are pruned first. A page an agent writes often keeps more rows than in 0.16 (docs/PERFORMANCE.md;
    docs/adr/2180-* .. 2182-*).
  • The Markdown download has snapshot markers. "Export as Markdown" in the web app and every zip export
    (format=zip, GET /api/workspaces/:id/export) now use notation=file: a chart or database view is its
    <!-- inkling:… --> line followed by <!-- inkling:snapshot -->, a table of its numbers and
    <!-- /inkling:snapshot -->, and a query block is followed by its results. Importing the file restores the
    blocks and drops the tables. notation=plain gives the 0.16 output; GET /api/pages/:id/export?format=md
    without notation is still plain (docs/adr/2122-*).
  • Zip imports and bearer folder imports by a connection follow the upload rules. A zip posted with a
    connection's token to POST /api/workspaces/:id/import is at most AGENT_UPLOAD_MAX_MB (default 5 MB), and its
    assets/ attachments, like the attachments of a bearer import-folder, are checked as upload_file checks them
    (the upload switch, the daily budget, the per-file cap, the type by bytes) and counted as the connection's uploads;
    refused ones are skipped and listed in skippedAttachments. Before, a bearer zip import stored any attachment
    unchecked. Imports from the browser are unchanged (docs/adr/2162-*).
  • Zip imports refuse unsafe archives (web and MCP): an entry with .. (JSZip used to collapse it silently), a
    symbolic link, or an entry that inflates more than 200 times its packed size past 1 MB is answered with 400.
    Names are normalized (NFC, \, leading /, drive letters), and names that are not UTF-8 are read as CP949
    (zips made by Windows Explorer on Korean systems) (docs/adr/2163-*).
  • A new server with no account prints a setup link. At boot, a server with no account writes a one-time
    <PUBLIC_URL>/setup?code=… link to its log; the account made with it is the administrator. The code is kept in
    memory only, works once and closes as soon as any account exists. Servers that already have accounts print
    nothing and behave as before; deploy/signup-key.sh keeps working. If container logs go to a service other
    people can read, create the first account right after the first start or use a signup key (docs/adr/2160-*).
  • [[Page#Heading]] now links to the heading. Markdown import, MCP writes and vault sync turn
    [[Page#Heading]] and [[Page#Heading|shown]] into a section link when Page is a page you can see and no page
    or split subpage is titled Page#Heading (those stay page links). A link written before 0.17 stays a page link
    until its line is written again. [[…]] inside a fenced code block is now left as code on import
    (docs/adr/2100-, 2104-).
  • Vault sync (still experimental, EXPERIMENTAL_FEATURES=vault-sync) behaves differently in six ways
    (docs/VAULT-SYNC.md):
    1. Page embeds, database views, link embeds, plugin blocks and charts are written to the note as one-line
      <!-- inkling:… --> block tokens, and the revision carries a format marker (md2). A note last synced by 0.16
      gets one 412 and a merge on its first upload; an edit on the line next to an embed then gives one conflict
      copy, and nothing is lost (docs/adr/2169-*).
    2. Deleting a folder in the vault trashes its folder page. This reverses ADR 0202's "folders are not deleted by
      sync" for folders that held notes at the last completed run; empty folders and the first run from a pre-0.17
      state file are exempt, so a git clone that drops empty folders deletes nothing (docs/adr/2167-*).
    3. A PUT with a stale revision answers 200 and writes nothing when the page already equals the note
      (docs/adr/2166-*).
    4. Creating a page takes a clientKey; a retry with the same key returns the same page with replayed: true
      (docs/adr/2166-*).
    5. A 403 on one note skips that note and lists it, and the run exits 0; a read-only token's run "succeeds" while
      writing nothing (docs/adr/2168-*).
    6. A folder X/ next to X.md is X's sub-page folder (before: a separate folder page with the same name).
  • A database view is a page embed with a viewId. A tab still running 0.16 keeps the block and shows a page
    card for the database; only if that tab moves or rewrites the block does it lose the view choice (docs/adr/2120-).
    A view whose filter uses OR, NOT or groups shows unfiltered in a 0.16 tab; a plain AND filter is still saved in
    the 0.16 format (docs/adr/2142-
    ).
  • GET /api/pages/:id/backlinks may carry a new sections field; clients that read only pages are unaffected
    (docs/adr/2101-*).

Added

  • Mermaid diagrams (docs/adr/2104-* .. 2106-, 2191-). A code block in language mermaid (or mmd) draws its
    diagram under the code: the code shows while you edit it (or always, with "Show code"), and a syntax error is one
    line in the block. Light and dark themes, narrow screens, presentation mode (diagram only), PDF export (waits for
    diagrams, prints them in the light palette) and public pages (/s/…, drawn in the reader's browser; if a diagram
    cannot be drawn its code stays). Mermaid runs with a strict configuration and is shown as an image. It is loaded
    only when a page has a diagram, and its source stays a ```mermaid fence for agents, vault sync and exports.
  • Section links [[Page#Heading]] (docs/adr/2100-* .. 2102-*). Type [[Page# to pick one of the page's
    headings; the link opens the page at that heading (folded sections open). The link follows the heading when it is
    renamed or moved; when the heading is gone the page opens and says so. The backlinks panel shows which heading
    each linking page points to; the graph counts section links as page links. Markdown export, MCP reads, vault sync
    and Notion publishing write them as [[Page#Heading]] (|shown when the text differs).
  • check_notes reports section links whose heading no longer exists: [[Page#Heading]] heading not found in page <id> (docs/adr/2103-*).
  • Database views in pages (docs/adr/2120-*). Type /database view (/데이터베이스 보기) to show one view of a
    database (table, board, gallery, calendar, timeline, chart or list) inside a page. The block stores only which
    database and which view: everyone sees the rows they can see, and a database you cannot see shows "Database not
    available" without its name. Rows open their page and "Open database" goes to the full view; the block is
    read-only in this release. ![[Database]] shows the database's first view.
  • Public pages show embeds, database views and query results (docs/adr/2121-, 2190-): an embedded page that is
    part of the link shows its title and text, a database view a table of its view, a query block its results, a link
    embed a card. Only data from pages inside the link is shown; anything else is one line, "Embedded content that is
    not part of this link."
  • Markdown download keeps charts, database views and queries with a snapshot of their numbers, and importing
    the file brings the blocks back (see Upgrade notes, docs/adr/2122-). Database tables on public pages and in the
    download show 0.17's automatic properties (IDs as TASK-12, ISO times, people's names) and table and list views
    show sub-items under their parent (↳); public pages never show the connection an agent used (docs/adr/2190-
    ).
  • Agents: read_page writes a database view as its page-embed line followed by <!-- inkling:view-info database "…", view "…" (board); its rows: query_rows -->; agents add a database view by writing the line
    (docs/adr/2123-*).
  • Database properties (docs/adr/2140-*): email and phone (mailto: / tel: links), and automatic, read-only
    created time, last edited time, created by, last edited by and ID (TASK-12: a prefix per prop...
Read more