On this page

Offline and PWA

Enable offline reading so technicians and other readers can reopen saved procedures without a connection. Offline mode is off by default and enabled per site.

Turning it on

curl -s -X PATCH "$DOCSARY_API/v1/sites/acme" \
  -H "authorization: Bearer $DOCSARY_KEY" \
  -H "content-type: application/json" \
  -d '{"settings":{"pwa":true}}'

settings is replaced wholesale, not merged. The call above erases any other settings the site had — logo, colours, footer links. Read the current object first with GET /v1/sites/acme, add your key to it, and send the result back.

With pwa enabled, supported browsers can offer to install your docs as an app. Installation options vary by browser and device.

What the manifest contains

/manifest.webmanifest is generated from site settings:

Field	Source
`name`, `short_name`	`settings.name`, falling back to the site's name
`start_url`	`/`
`display`	`standalone`
`theme_color`	`settings.colors.primary`, falling back to ink `#17181c`
`background_color`	`#ffffff`
`icons`	`settings.logo` if set, declared at `sizes: "any"`; otherwise empty

Use an SVG for settings.logo so the install icon scales clearly. Small raster images may look blurred.

When pwa is off, /manifest.webmanifest returns 404.

What it stores, and when

When connected, Docsary requests pages from the network and saves successful responses. If a network request fails, it uses the stored copy when one exists.

Only previously opened pages are available offline. There is no whole-site download. Open the pages and images you need, then test them without a connection before leaving.

Only GET requests on the docs hostname are eligible. API paths, other origins, and writes are excluded. New search queries require a connection.

Publishing and the offline cache

Publishing replaces the offline cache when the reader reconnects and receives the update. Pages must then be opened again to make them available offline.

A disconnected reader can still see an older copy. Publishing cannot update a device without a connection. Reconnect and reopen critical procedures before relying on them.

Turning it off

Set pwa back to false:

curl -s -X PATCH "$DOCSARY_API/v1/sites/acme" \
  -H "authorization: Bearer $DOCSARY_KEY" \
  -H "content-type: application/json" \
  -d '{"settings":{"pwa":false}}'

Readers receive the disable update when their browser checks for it online. It clears stored copies, removes offline support, and reloads open docs tabs.

A disconnected device cannot receive this change until it reconnects. Browser update timing can vary.

Not included

Offline mode supports reading saved pages. It does not provide push notifications, background sync, offline editing, or app-store distribution.

PreviousSearch and AI NextAPI reference