Skip to Content
WebFrostdocs
Guides

Public read

Let anyone browse the archive read-only with WEBFROST_PUBLIC_READ, and what guests can and cannot do.

Set WEBFROST_PUBLIC_READ=true to let anonymous visitors browse, search and download from the archive without an account. Everything that changes anything still requires signing in.

WEBFROST_PUBLIC_READ=true

With Docker Compose, put it in .env; the production Compose file passes it through.

The whole archive becomes readable

Public read exposes every snapshot, not a chosen subset, including pages that were private when you captured them: anything behind a login that you archived, internal pages (with WEBFROST_ALLOW_PRIVATE_URLS), or content you forgot about. Turn it on only if everything in the archive may be seen by anyone who can reach the server. Deleting a snapshot is the only way to hide one.

What guests can do

Guests can make GET and HEAD requests to this fixed list of API routes. The list is matched on method and exact path, so a new route is private unless it is added to it.

RoutePurpose
GET /api/v1/snapshotsList snapshots and full-text search (?q=)
GET /api/v1/snapshots/:idSnapshot detail with per-extractor status
GET /api/v1/snapshots/:id/tagsTags on a snapshot
GET /api/v1/snapshots/:id/archives/:extractor/downloadDownload an archived file
GET /api/v1/snapshots/:id/archives/:extractor/previewSandboxed HTML preview
GET /api/v1/tagsList tags
GET /api/v1/statsDashboard statistics

GET /health, POST /api/v1/auth/login, GET /api/v1/setup/status and POST /api/v1/setup (only while no admin exists) work without credentials with or without public read.

What guests cannot do

Every other route answers 401: all POST, PATCH and DELETE requests, and also /api/v1/schedules, /api/v1/imports, /api/v1/import, /api/v1/settings/* (info and API keys) and GET /api/v1/auth/me. Guests cannot archive, delete, tag, import, schedule, change settings or read API keys.

Storage paths are hidden

Storage paths and S3 keys never appear in API output, for guests or admins: a file-backed archive result has content: null and a downloadUrl such as /api/v1/snapshots/1/archives/pdf/download. The storagePath in server info is behind login.

The web UI as a guest

Guests see the Dashboard, Snapshots, Search and Tags pages, can open any snapshot, and can download or preview its files. A Read-only marker and a Sign in link appear in the sidebar. Controls for archiving, deleting, tagging, importing, schedules, settings and API keys appear only after signing in. Opening one of those pages as a guest leads to the login screen and back to the page afterwards. The UI learns about public read from GET /api/v1/setup/status, which returns { needsSetup, publicRead }.

Rate limits

Guests share the read limit of 300 requests per minute per client address. Behind a reverse proxy set WEBFROST_TRUST_PROXY=true, or every guest counts as the proxy. See Rate limits.

On this page