Skip to content

Releases

v0.3.1

Choose a tag to compare

@github-actions github-actions released this 22 Nov 20:46
478bbcf

Patch Changes

  • Updated dependencies [f502c66]
    • @webfrost/core@0.3.1
    • @webfrost/server@0.3.1

v0.2.0

Choose a tag to compare

@github-actions github-actions released this 22 Nov 05:57
8957e2d

Patch Changes

  • 9e70e13: The webfrost binary archives screenshots, PDFs and SingleFile again. Built into a single file, it looked for the browser library's own files at the path of the machine that built it, so on any other machine the browser never started and only HTML, WARC and readable text were saved. webfrost setup and webfrost doctor now open a blank page to check that the browser really works (a browser can answer --version and still lack the libraries a page needs), and when a system library is missing they print the command that installs them with your package manager: apt-get (with the names Debian and Ubuntu use), dnf or pacman.
  • Updated dependencies [66ff385]
  • Updated dependencies [4ab82e0]
  • Updated dependencies [07c0901]
  • Updated dependencies [037d94f]
  • Updated dependencies [07c0901]
  • Updated dependencies [66ff385]
    • @webfrost/server@0.2.0
    • @webfrost/core@0.2.0

v0.1.0

Choose a tag to compare

@github-actions github-actions released this 22 Nov 04:05
69a5d82

Everything up to the first published version. The details are in the changesets in
.changeset, which become each package's changelog.

Install and run

  • A single webfrost binary for macOS and Linux (x64 and arm64), with the CLI, the server and
    the web UI inside. Installed with curl -fsSL https://webfrost.dev/install.sh | sh,
    brew install gtkatakura/tap/webfrost; the scripts
    verify the release checksum.
  • webfrost serve runs the server, web UI and scheduler in one process and generates a session secret
    in the data directory when none is set; webfrost setup installs a headless Chromium only if none is
    found; webfrost doctor checks the data directory, database, Chromium, yt-dlp, ffmpeg and port.
  • A Docker image for amd64 and arm64 with Chromium, yt-dlp and ffmpeg, running as a non-root user, and
    a production Compose file served at https://webfrost.dev/compose.yml
    (curl -fsSLO https://webfrost.dev/compose.yml && docker compose up -d), with an optional Litestream
    service for continuous SQLite backups.
  • The CLI and the server share one archive, ~/.webfrost by default (WEBFROST_DIR).

Archiving

  • Eight formats from one HTTP fetch and one browser navigation: WARC 1.1, raw HTML, readable text
    (Readability), PDF, full-page screenshot, DOM snapshot, self-contained HTML (SingleFile) and video or
    audio through yt-dlp. One extractor failing never fails the snapshot; each one records why it did not run.
  • WARC records keep the body exactly as the server sent it, with digests, a record per redirect, and
    pass warcio check. Pages are decoded with their declared charset.
  • Real sites come out complete: the browser waits for single-page apps to finish loading
    (WEBFROST_SETTLE_MS), SingleFile copies keep their stylesheets, CSS images and <picture> images,
    PDFs print backgrounds, and readable text keeps its paragraphs.
  • Pages are archived in a light or dark color scheme: the web UI uses its own theme, the API and SDK take
    colorScheme, everything else WEBFROST_COLOR_SCHEME.
  • Videos at up to 1080p in H.264 and AAC, which every browser plays (WEBFROST_MEDIA_MAX_HEIGHT).
  • Imports from plain URL lists, Netscape bookmarks, OPML and RSS/Atom feeds.
  • Cron schedules for URLs and feeds (names, ranges with steps, @daily-style aliases, correct across
    DST changes), run by the server itself or by webfrost schedule worker.
  • A job queue with a shared concurrency limit, leases that survive crashes and restarts, fenced writes,
    timeouts that really cancel the work, and a minimum gap between two archives of the same site
    (WEBFROST_DOMAIN_DELAY_MS).

Data

  • Metadata in SQLite by default, or in PostgreSQL 13+ or MySQL 8.0.13+ through DATABASE_URL, with the
    schema created and migrated automatically.
  • Full-text search on every engine (FTS5, tsvector, FULLTEXT) over URLs, titles, extracted text and
    tag names, with highlighted snippets.
  • Archive files on the local filesystem or in S3-compatible storage (S3, MinIO, R2, B2), streamed
    without loading them into memory.

Surfaces

  • webfrost CLI: serve, setup, doctor, add, list, search, import, delete, schedule,
    tag, admin, init, search:rebuild, with --help on every command, --json output where it
    makes sense, and exit codes scripts can rely on.
  • HTTP API v1 under /api/v1: one error shape ({ error, code }), one list envelope
    ({ items, total, page, limit }), ISO 8601 timestamps, no storage paths in responses. The unversioned
    /api is a deprecated alias that answers with Deprecation and Link headers.
  • A TypeScript SDK, @webfrost/sdk, ready in the repository and published to npm after this release.
  • Web UI in the WebFrost "Ice Blue" look, light and dark: dashboard, a snapshot list as cards or rows, a
    full-window viewer per snapshot (/#/snapshots/:id: the sandboxed page, reader, screenshot, video,
    files and details, with full screen), search with highlights and saved searches, tags,
    schedules, imports, API keys, a command palette and keyboard shortcuts, clear error states,
    accessible dialogs and a phone layout.
  • Agent skills (npx skills add gtkatakura/webfrost) for using and self-hosting WebFrost.
  • Documentation at webfrost.dev.

Observability

  • Optional OpenTelemetry export of traces, metrics and logs over OTLP/HTTP to your own collector. Off
    unless OTEL_EXPORTER_OTLP_ENDPOINT is set; only hosts of archived pages are recorded by default.
    WebFrost collects no telemetry of its own.

Security

  • API keys (stored hashed, optional expiry) and server-side sessions, revoked on logout and on password
    change.
  • CSRF protection for cookie-authenticated requests, JSON-only bodies, and a setup token
    (WEBFROST_SETUP_TOKEN) so nobody else can claim a fresh instance.
  • Login and API rate limits; X-Forwarded-For trusted only with WEBFROST_TRUST_PROXY, read from the
    right (WEBFROST_TRUSTED_PROXY_HOPS).
  • Read-only public mode (WEBFROST_PUBLIC_READ): visitors browse and search, only signed-in users change
    anything.
  • SSRF guard on every fetch, every redirect hop and every request the headless browser makes.
  • yt-dlp runs without config files, playlists or the generic extractor, in its own process group.
  • Archived pages are previewed in a sandbox (CSP sandbox, no scripts, opaque origin); S3 downloads
    are forced to download, never render.
  • Request size limits, list pages capped at 200, and graceful shutdown that lets running archives finish.

Fixed

  • Bun upgraded to 1.4.4: Bun 1.3 closed already-closed file descriptors of child processes, which could
    close the archive database's files after the browser exited (SQLITE_IOERR).

v0.1.0-rc.4

v0.1.0-rc.4 Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 22 Nov 02:24
0054ebb

What's Changed

New Contributors

Full Changelog: https://github.com/gtkatakura/webfrost/commits/v0.1.0-rc.4