Add version to StatsResponse and getStats so the canonical public monitoring endpoint reports the running build alongside the footer and /health. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
44 KiB
TODO
Feature gaps identified by comparing with kill-the-newsletter.
Origin tags. Every idea carries an
_origin:_reference so we can notify the source when it ships.
ktn#N→ a kill-the-newsletter issue/PR — comment there when implemented to close the loop with the requester.- A tool/spec URL → external inspiration (a competitor or standard); no individual to notify, but the rationale is traceable.
internal→ our own design/code audit; no external requester.
Priority × size. Each idea is tagged
Pn·Size. Priority by user value: P1 (high) / P2 (medium) / P3 (nice-to-have). Effort by implementation size: S (hours) / M (~1–2 days) / L (several days) / XL (week+). Done items keep the tag as a retrospective estimate.
Quick wins
-
P1·SAuthor field in RSS entries — expose thefromaddress as<author>in each RSS<item>. The value is already stored in KV, just not rendered in the feed XML. — origin: ktn#102 (ktn CHANGELOG 2.0.6 "author to entry") -
P1·MHTML view for individual entries — serve each email as an HTML page at e.g./entries/:feedId/:timestamp. Useful for reading emails outside a feed reader and for debugging. kill-the-newsletter serves these at/feeds/{feedId}/entries/{entryId}.htmlwith a Content-Security-Policy header. — origin: upstream alternate-HTML view; gives each item a valid URL (ktn#17, ktn#40) -
P2·SJSON API for feed creation — acceptContent-Type: application/jsononPOST /admin/feedsand return{ feedId, email, feedUrl }. Useful for automation (e.g. Tofu/OpenTofu provisioning). — origin: ktn#43 (ktn CHANGELOG 2.0.5) -
P2·SProject favicon — serve a single bundled icon at/favicon.icoand add a<link rel="icon">in the sharedLayoutso the admin UI, status page, and entry views stop 404-ing. Doubles as the default/fallback icon for the per-feed favicon feature below. — origin: internal (404 fix); related ktn#131
Medium effort
-
P2·MSize-based feed trimming — instead of a fixed 50-entry cap, drop the oldest entries when the feed exceeds a size threshold (kill-the-newsletter uses ~512 KB). More robust for HTML-heavy newsletters where one entry can dominate. — origin: upstream size limit (ktn CHANGELOG 2.0.8); related ktn#59, ktn#115 -
P1·MAtom feed format — expose feeds as Atom (application/atom+xml) in addition to or instead of RSS 2.0. Atom has better native support for HTML content and author metadata. — origin: upstream (Atom-native product) / internal parity -
P3·MAuthelia / external auth provider support — allow delegating admin authentication to an external identity provider (e.g. Authelia, Authentik) via a trusted header (Remote-User,X-Forwarded-User) set by a reverse proxy. The Worker would accept the header as proof of authentication instead of checking the cookie, with a configurable secret or IP allowlist to trust only the proxy. — origin: internal -
P2·MPer-feed favicon from the last sender's domain — give each feed an icon by fetching the favicon of the last sender's domain, so feeds are visually distinguishable in readers and the admin UI. Resolve the domain from the most recent email'sfrom, fetch its favicon (e.g.https://<domain>/favicon.icoor a parsed<link rel="icon">, with a fallback service), and cache the result aggressively (KV/R2 + Cache API with a long TTL) so it isn't re-fetched on every request. Expose it via the RSS<image>/ Atom<icon>and the admin feed list. — origin: ktn#92 (ktn CHANGELOG 2.0.6/2.0.7) -
P2·MRFC 8058 one-click unsubscribe on feed deletion — when a feed is deleted, automatically unsubscribe from the newsletters that fed it so messages stop arriving at the now-dead address. Parse and store theList-Unsubscribe/List-Unsubscribe-Postheaders (RFC 8058) from incoming emails, then on deletion POSTList-Unsubscribe=One-Clickto each stored unsubscribe URL. Requires capturing the headers during ingestion (src/lib/email-processor.ts) and firing the outbound requests from the feed-delete paths (src/routes/admin/feeds.tsx), ideally viactx.waitUntil. — origin: internal (RFC 8058)
Heavy
-
P1·LEmail attachments as RSS enclosures — store attachments in Cloudflare R2 and expose them as<enclosure>elements in the feed. kill-the-newsletter serves them at/files/{enclosureId}/{filename}. — origin: ktn#66, ktn#86 (ktn CHANGELOG 2.0.5) -
P2·LWebSub (PubSubHubbub) push notifications — notify subscribers in real time when a new email arrives, instead of requiring them to poll the feed. Requires either integrating a public WebSub hub or implementing the hub protocol directly. — origin: ktn#68 (ktn CHANGELOG 2.0.4) -
P2·SRate limiting via Cloudflare WAF rules — protect/api/inboundand/adminagainst abuse. Configure WAF custom rules in the Cloudflare dashboard (or via Terraform): rate-limit/api/inboundto ~60 req/min per IP, and/adminto ~20 req/min per IP. No code changes required; this is pure infrastructure configuration. — origin: upstream parity (ktn CHANGELOG 2.0.3) / internal -
P2·LREST API with OpenAPI description — expose a documented, machine-consumable REST API for feed/email management (create/list/update/delete feeds, list/read/delete emails, read stats) so the service can be automated without scraping the admin UI. Implemented as a versioned/api/v1/*surface (Bearer-token auth with the admin password, plus the existing proxy-auth) built on@hono/zod-openapi; the OpenAPI 3.1 spec is served at/api/openapi.jsonwith a Scalar docs page at/api/docs. Feed create/update/delete logic was extracted intosrc/lib/feed-service.tsso the admin UI and the REST API share a single source of truth. — origin: ktn#43 -
P3·XLMigrate feed metadata to Durable Objects for atomic writes — the current KV-based metadata store has a read-modify-write race condition: two concurrent emails to the same feed can silently overwrite each other's changes. Cloudflare Durable Objects serialise access per feed and eliminate the race entirely. Requires replacingfeed:<feedId>:metadataKV writes insrc/lib/email-processor.tswith a Durable Object that exposes anappendEmail()RPC, updatingwrangler.tomlwith a DO binding, and migrating existing metadata at deploy time. — origin: internal; same race behind ktn#6, ktn#31
From upstream issues/PRs (2026-05-24 review)
Gaps found by reading every open/closed issue + PR on kill-the-newsletter. These are requests we do not yet satisfy (many other recurring requests — dark mode, copy buttons, favicon, expiration, attachments, API, WebSub, sender-in-author — we already cover).
-
P1·MSubscription confirmation handling — the single most recurring upstream request (#5, #23, #57, #73, #89, #95, #97). Newsletters require a "click to confirm your email" step; users can't easily find/click the link buried in a feed reader. Our admin already lists emails, but nothing surfaces the confirmation link or shows the first email inline right after feed creation. Low effort, high payoff (admin UX insrc/routes/admin/feeds.tsx+ maybe extract candidate confirm links during ingestion insrc/application/email-processor.ts). — Shipped: v1 detects confirmation emails at ingestion (multilingual keyword + link scoring) and surfaces the link in the admin (detail section, list badge, dashboard pill, emails-page banner + dismiss); post-create now lands on the feed's emails page. v1 does no outbound request; server on-detect actions deferred (see below). -
P2·MConfirmation on-detect server action (none / autoclick / forward) — extend the shipped confirmation detection with a server-configured action via an env var (defaultnone):autoclick= follow the detected confirm link server-side from the worker (⚠ guard SSRF: http(s) only, block internal/private IP ranges, timeout, no redirect to non-http schemes);forward= forward the original email toFALLBACK_FORWARD_ADDRESS. Touchessrc/application/email-processor.ts,Env(src/types/index.ts),src/infrastructure/cloudflare-email.ts. — origin: internal (juherr) -
P1·MSeparate write (email) / read (feed) IDs — most-requested privacy gap, still open upstream (#114, #93, #75). The two identities are now decoupled:FeedIdis an opaque random token (FeedId.generate()→ 22-char base64url) used as the KV storage key and the public read id (/rss/:feedId), while the inbound address is a separateMailboxIdVO (noun.noun.NN, the old format) resolved to its feed only at reception via a newinbound:<mailboxId>secondary index (src/infrastructure/feed-repository.tsresolveInbound).MailboxId.parseowns the untrusted-input boundary (moved offFeedId); the mailbox lives onFeedState.mailboxId/mailbox_idand is projected intofeeds:list. Reading/rss/<noun.noun.NN>404s and no public feed output contains the inbound address. Pre-release, so no migration/backward-compat. — origin: ktn#114, ktn#93, ktn#75 -
P2·SRotate the inbound mailbox and/or feed id — follow-up to the write/read separation above. Now that the inbound address (MailboxId) and the read id (FeedId) are decoupled, offer an admin + REST action to re-mint either one to revoke a leaked subscribe address or a shared feed URL. Rotating the mailbox: generate a newMailboxId, write the newinbound:<new>index, delete the old; rotating the read id is heavier (it's the KV storage key — would require re-keyingfeed:<id>:*, so prefer rotating only the mailbox first). Touchfeed-service.ts,feed-repository.ts, admin UI,api/index.ts. — origin: internal (privacy) -
P2·MProxy/prefetch remote images (#69). We already proxy inlinecid:images via R2, but remote<img src="https://…">stay remote → tracking pixels fire on read. Extendsrc/infrastructure/html-processor.tsto rewrite remote image src through a worker proxy/cache endpoint (reuse the R2 + Cache API pattern from favicons). -
P3·MTracking-link redirect resolver (#36). Unwrap marketing/tracking URLs (e.g.click.convertkit-mail…) to their final destination so the redirect/tracking happens server-side (or is stripped) instead of from the reader. Lives insrc/infrastructure/html-processor.ts. Mind SSRF/abuse surface when following redirects. -
P2·SStrip-styles / plaintext rendering option (#74, #119). Some readers render newsletter HTML/CSS poorly. Offer an opt-in to strip<style>+ inline styles (keeping links), or to prefer thetext/plainpart. Per-feed setting +src/infrastructure/html-processor.ts. -
P2·SOptional sender in entry title (#123 — open PR upstream, #124). We already emit<author>, but some users want[Sender] Subjectas the entry title for at-a-glance scanning in the reader. Per-feed toggle +src/infrastructure/feed-generator.ts. — Shipped: per-feedsenderInTitleflag (domainFeedState.senderInTitle↔FeedConfig.sender_in_title); when set,buildFeedprefixes each entry title with[Sender](display name, falling back to the email address). Toggle exposed as an admin edit-form checkbox and on the REST API (FeedCreate/FeedUpdate/Feedschemas). -
P2·SDetect a newsletter's native Atom/RSS feed — top item on upstream's own TODO, not yet built there. When an incoming email's HTML contains<link rel="alternate" type="application/atom+xml">(orapplication/rss+xml), surface it: "this newsletter already publishes a feed — subscribe to it directly instead." We already parse HTML with linkedom insrc/infrastructure/html-processor.ts, so detection is cheap; store the discovered URL on the feed and show it in the admin UI / a feed entry. A genuine differentiator — we'd ship it before upstream. -
P1·SX-Robots-Tag: noneon feed + entry routes (#33). Private feeds/emails should never be search-indexed. Upstream setsX-Robots-Tag: noneon its responses; we set a CSP on/entriesbut no robots header anywhere. AddX-Robots-Tag: noindextorss.ts,atom.ts,entries.ts,files.ts(and optionally a/robots.txt). Low effort, real privacy gap.
From similar projects & RSS readers (2026-05-24 review)
Ideas from competitors (Feedbin, Readwise Reader, Inoreader, Omnivore, LetterFeed, Mailbrew, mail2rss) and from what leading readers (NetNewsWire, Reeder, Feedly, Inoreader, NewsBlur, Miniflux, FreshRSS) can consume. Deduplicated against the upstream-issues section above. Tagged [table-stakes] vs [differentiating].
Feed-output enrichments (small XML wins — we use the feed lib, which already emits content:encoded, atom:link rel="self", stable <guid>)
-
P2·SJSON Feed endpointGET /json/:feedId[differentiating, cheap] — thefeedlib's.json1()(emits JSON Feed v1) wired viagenerateJsonFeedinsrc/infrastructure/feed-generator.ts, served at/json/:feedId(src/routes/json.ts) withContent-Type: application/feed+json+ WebSub hubLink. All three formats cross-link viafeedLinks. Natively consumed by NetNewsWire, Reeder, NewsBlur, Feedly. — origin: JSON Feed 1.1 spec (reader ecosystem) -
P3·SUpgrade JSON Feed output to v1.1 [correctness, niche] — our/json/:feedIdemitsversion: "https://jsonfeed.org/version/1"because thefeedlib's.json1()only implements v1, and the upstream request to bump it was closed as not planned (jpmonette/feed#139). So a true v1.1 feed needs a small post-process pass on the.json1()object ingenerateJsonFeed(src/infrastructure/feed-generator.ts): setversiontohttps://jsonfeed.org/version/1.1, and apply the v1.1 changes — promote the deprecated top-level/itemauthortoauthors(array), and add the top-levellanguagefield. Low value (every reader still parses v1) but cheap and removes a spec-compliance footnote. — origin: jpmonette/feed#139 (closed, not planned); JSON Feed 1.1 spec -
P2·MPer-item<category>+ per-feed tags/categories [differentiating] — we set no categories today. Tag entries by sender (or a user-set feed category) so readers (Inoreader, Feedly, NewsBlur) can filter/mute subsets. Pairs with the filtering item below; touchesFeedState,feed-generator.ts. — origin: RSS best practices (kevincox); Inoreader/Feedly filtering -
P3·SReader cadence hints:<ttl>+sy:updatePeriod/sy:updateFrequency[table-stakes, niche] — advertise the feed's real update rhythm so pollers (FreshRSS, Miniflux, Inoreader) back off; complements our WebSub push. Support is uneven, so keep it as a hint alongside WebSub. Also advertise the WebSub hub link inside the XML (<atom:link rel="hub">), not only the HTTPLinkheader. — origin: FreshRSS TTL #6721 -
P2·MMedia RSS lead image (<media:content>/<media:thumbnail>) [differentiating] — extract the first image of each email as a thumbnail so card/story layouts (Feedly, Inoreader, NewsBlur) show a preview. Thefeedlib doesn't emit Media RSS, so this needs post-processing or a custom serializer. — origin: Media RSS spec; Feedly/Inoreader consume it
Ingestion & processing
-
P2·MKeyword/subject filtering rules (keep/drop) [differentiating] — we already have sender allow/block (SenderPolicy), but no content rules. Add per-feed keep/drop rules by subject or body keyword (Inoreader/Omnivore-style), applied insrc/application/email-processor.tsat the same gate as the sender policy. — origin: Inoreader rules; Omnivore filters -
P2·MConfirmation-code relay [differentiating] — extends the "Subscription confirmation handling" item above. Readwise Reader auto-detects "reply with code X" / "click to confirm" emails and surfaces (or relays) the code. Beyond just showing the link: detect the confirm pattern and present a one-tap action in admin. — origin: Readwise Reader docs; also ktn#89 (reply-to-confirm) -
P3·XLIMAP-pull ingestion option [differentiating for self-hosters] — alternative to the ForwardEmail/Cloudflare-Email webhook: poll an existing IMAP mailbox and route allow-listed senders to feeds (LetterFeed model). Big lift on a Worker (needs a scheduled fetch + IMAP over a TCP socket / external relay); evaluate feasibility before committing. — origin: LetterFeed; also ktn#26 (use IMAP instead of hosting a mail server)
Reading experience
-
P2·SOPML exportGET /admin/opml[table-stakes, easy] — export all feeds as an OPML 2.0 outline (<outline type="rss" xmlUrl=…>per feed, XML-attr-escaped) so users can bulk-import every feed into their reader in one shot. Mounted on the admin Hono app (inherits the admin auth middleware) rather than public, because the registry lists every feed's RSS URL — a public endpoint would leak them all. ReturnsContent-Disposition: attachment; filename="feeds.opml". Implemented insrc/routes/opml.tsoverFeedRepository.listFeeds(). — origin: reader ecosystem (NetNewsWire); Feedbin OPML export -
P2·LFull-text search across received emails [differentiating] — admin-side search over subjects + bodies (Omnivore/Feedbin have this). On KV this means an index or scan; consider scope (subject-only first) before building. — origin: Omnivore; Feedbin search -
P3·LReadability / clean-text view toggle [differentiating] — related to "strip-styles" above but distinct: run a readability extraction (article body only) as an opt-in per feed, remembered per sender (Readwise pattern), rather than just stripping CSS. — origin: Readwise Reader feed docs
Greenfield differentiators
-
P2·LAI per-newsletter summarization [differentiating] — generate a short TL;DR per email (or a daily digest summary) using Cloudflare Workers AI (no new vendor, no key to manage). Almost no competitor ships this well. Add anAIbinding + an opt-in per-feed flag; render the summary atop the entry content. — origin: Precis, babarot AI reader -
P3·LDigest / bundling mode [differentiating] — for low-volume feeds, batch N emails into a single periodic digest entry (Mailbrew model) so readers aren't flooded. Per-feed cadence setting; runs on the existing cron. — origin: Mailbrew
Robustness, delivery, auth & integrations (2026-05-24 deep dig)
Verified-missing in our code, deduplicated against the sections above. From a code audit + a sweep of niche/recent tools (Precis, changedetection.io+Apprise, MailCast email-to-podcast, FreshRSS/Miniflux token auth, RFC 5005, postly dedup).
Delivery / bandwidth
-
P2·SConditional GET on feeds (ETag + Last-Modified + 304) [table-stakes, easy] —rss.ts/atom.tsnow emit a strongETag("<format>-<feedId>-<count>-<maxReceivedAt>") andLast-Modified(newestreceivedAt), and return304 Not Modifiedon matchingIf-None-Match/If-Modified-Sincebefore generating any XML. Validators are computed from the loadedFeedData(not the rendered bytes) insrc/infrastructure/http-cache.ts(computeFeedValidators/isNotModified/notModifiedResponse), shared by both routes; rss vs atom get distinct ETags via the format prefix. Cuts bandwidth for every polling reader. — origin: internal code audit (RFC 9110 conditional requests) -
P3·LRFC 5005 paged / archived feeds [differentiating, niche] — readers only ever see the capped current window; older entries vanish. Mark the subscription documentfh:completeand exposeprev-archivepages so readers can backfill history. Pairs naturally with our expiring-feed model (an expired feed = a sealed archive). (RFC 5005)
Ingestion robustness
-
P1·MDuplicate-send dedup [differentiating] — a newsletter resent (or delivered twice) is now stored once.storeEmail(src/application/email-processor.ts) computes theMessage-ID(case-insensitive header lookup) and a SHA-256 of normalizedsubject+content, then asks the aggregatefeed.hasDuplicate(messageId, dedupHash)(src/domain/feed.aggregate.ts): primary match onMessage-ID, fallback to the content hash when neither side has a Message-ID. A duplicate is a successful no-op ({ ok: true }, nothing stored/dispatched) and bumps a newemails_deduplicatedcounter (status page +/api/v1/stats).EmailMetadatagained additivemessageId?/dedupHash?fields, so pre-feature entries never false-match. Fixes the upstream "duplicate posts" complaint (#31, #6). -
P3·MCalendar (.ics) invite extraction [differentiating, novel] — no email→feed tool does this. Detecttext/calendarparts, parse the event, and surface it in the entry (summary + an.icsenclosure / add-to-calendar link). Useful for event/booking newsletters. — origin: internal (novel; no external requester) -
P2·SFALLBACK_FORWARD_ADDRESS— catch-all fallback forwarding [differentiating for self-hosters] — todayhandleCloudflareEmailsilently drops (justlogger.warn) any address that isn't a feed, so you can't point a domain's catch-all at KTN without swallowing your personal mail. Add an optionalFALLBACK_FORWARD_ADDRESSenv var: afterprocessEmail, forward non-feed mail to it based onresult.reason— forward oninvalid_address(not anoun.noun.NNaddress) andfeed_not_found(well-formed but no such feed); drop onfeed_expiredandsender_blocked(don't leak a newsletter to the fallback box); nothing onok. Unset env → current drop+log behavior unchanged. The destination must be a verified Cloudflare Email Routing address ormessage.forward()fails;awaitit in atry/catch(logger.warnon failure), forward at most once. Touch:Env(src/types/index.ts),src/infrastructure/cloudflare-email.ts(result.reasonalready available),cloudflare-email.test.ts(forwarded forfeed_not_found/invalid_addresswhen set; not forfeed_expired/sender_blocked; not when unset),wrangler-example.toml(commented# FALLBACK_FORWARD_ADDRESSunder[vars]),INSTALL.md("Catch-all fallback forwarding" section: verified-destination prerequisite + use case). — origin: internal (juherr — self-host on juherr.dev catch-all); generic "use KTN as my domain's catch-all"
Auth & privacy
-
P2·MScoped / multiple API tokens (admin-managed) [security] — the REST API currently accepts the singleADMIN_PASSWORDas the bearer (src/infrastructure/auth.ts). Add named, independently-revocable tokens (optionally read-only or feed-scoped) that the admin can create, list, and revoke from the admin UI (stored hashed in KV, shown once on creation), so automation doesn't hold the master password. The bearer middleware then accepts eitherADMIN_PASSWORDor any active token; revoking a token is instant. — origin: internal security audit; juherr (manage API tokens) -
P2·SChange the admin password from the UI [security] — todayADMIN_PASSWORDis a Worker secret set viawrangler secret put, so rotating it means a redeploy. Add an admin-UI action (current password + new password) that stores a hashed password override in KV (e.g.admin:password);src/infrastructure/auth.tschecks the KV override first and falls back to theADMIN_PASSWORDenv secret when unset, so existing installs keep working and the env var becomes the bootstrap/reset default. Pairs with the API-tokens item (same auth surface). — origin: internal; juherr (change admin password) -
P3·XLMulti-user support [differentiating] — today the app is single-admin (oneADMIN_PASSWORDguards all feeds;feeds:listis global). Support multiple user accounts, each owning a private subset of feeds: per-user credentials/sessions, feed ownership onFeedState, per-user feed registry (scopefeeds:listby owner), and admin scoping across the admin UI + REST API. Big lift — touches auth, the feed registry/key schema, and every admin/API route; depends on the change-password and API-token items as the auth foundation. ⚠ Note the off-Cloudflare epic currently lists "Multi-tenant / multi-domain admin" as out of scope — reconcile that scope boundary before committing. — origin: internal; juherr (multi-user) -
P2·MToken-protected private feeds [security, differentiating] —/rssand/atomare public-by-obscurity (anyone with the URL reads it). Offer an opt-in?token=…(FreshRSS-style) or HMAC-signed, optionally expiring URL (fits our expiring-feed model) so a feed can be truly private and shareable without leaking the inbound address. Complements the separate write/read IDs item above. (FreshRSS)
Push & integrations
P2·LPush new items to chat (per-feed) [differentiating] — for users who don't run a reader, push each new email to Telegram / Discord / ntfy / a generic webhook, routed per feed, instant-vs-digest toggle (Precis / changedetection.io+Apprise pattern). Fires from the existing event dispatcher (src/application/feed-events.ts) viactx.waitUntil. (Precis)
Novel / stretch (Cloudflare-native)
-
P3·MMCP server over your feeds [differentiating, novel] — expose feeds/emails to AI agents via a Model Context Protocol endpoint on the Worker, so an assistant can read/search a user's newsletters. Cheap to add on a Worker, genuinely new in this space. — origin: babarot AI reader + MCP -
P3·LEmail-to-podcast (TTS audio enclosure) [differentiating, novel] — opt-in: synthesize each newsletter to audio (Cloudflare Workers AI TTS), store in R2, attach as an<enclosure>so the feed doubles as a private podcast. Reframes feed item = audio. (prior art)
Framing notes (no code, worth surfacing in docs/landing): we already deliver several things competitors charge for — full-body capture bypasses Substack/"read more" truncation (we ingest the email, not the scraped page), and each feed's inbound address is effectively a burnable alias (delete the feed + RFC 8058 one-click unsubscribe already kills the sender). Market these explicitly.
Feed namespaces & reader-rendering correctness (2026-05-24 deep dig)
Two final angles: (1) less-common RSS/Atom namespaces that visibly improve feeds in real readers, and (2) generator-side correctness fixes that stop feeds breaking in self-hosted readers. The feed lib emits content:encoded/atom:link rel=self/stable <guid> but does not handle the items below — they need its custom-namespace/extension hooks or a post-process pass.
Namespaces worth emitting
-
P2·SWebFeeds branding (webfeeds:accentColor,webfeeds:icon,webfeeds:logo,webfeeds:cover) [differentiating, high visible payoff] — Feedly puts your SVG logo on every story and recolors links to your accent color. We already derive a per-feed favicon; add an accent + logo for branded-looking feeds. — origin: Working With Web Feeds (CSS-Tricks) -
P2·MMedia RSS thumbnail/credit (media:thumbnail,media:description,media:credit) [differentiating] — richer than the lead-image item above: gives readers a card image, alt text, and attribution. — origin: Media RSS spec -
P3·SDublin Coredc:creator[niche, cheap] — credits the newsletter sender without an email address (RSS<author>requires one); safer than a syntheticnoreply@. — origin: RSS Best Practices Profile, mod_dublincore -
P3·MPodcast namespace (itunes:*+podcast:transcript/chapters) [stretch] — only if the email-to-podcast item ships; turns the audio feed into a real Podcasting 2.0 feed. — origin: Podcast Namespace
Reader-rendering correctness (turn these into hardening tasks)
-
P1·SRewrite relative URLs in content to absolute [correctness] — most readers ignorexml:base; relativesrc/hrefincontent:encodedbreak in Miniflux/NetNewsWire. Absolutize every link/image before emitting (src/infrastructure/html-processor.ts). — origin: W3C ContainsRelRef -
P1·SPromote lazy-loaded images (data-src→src, striploading="lazy") [correctness] — newsletters with lazy images render blank in readers. — origin: Hugo RSS & lazy images -
P1·SStrip XML-illegal control chars + guarantee valid UTF-8 [correctness] — a single bad codepoint fails the whole feed parse in strict readers (newsboat). Sanitize before serialization. — origin: newsboat #2328, W3C SAXError; upstream hit this too (ktn#1 cyrillic, ktn#9 invalid XML char) -
P2·SRealenclosurebyte length + correct type (neverlength="0") [correctness] — zero/missing length makes podcast clients reject the enclosure; use the actual R2 object size. — origin: AzuraCast #7809 -
P1·SPlain-text<title>(strip HTML, decode entities) [correctness] — raw tags in titles show literally in readers; keep markup only incontent. — origin: RSS.app feed output guide; upstream ktn#11 (subject placed as link)
Per-feed favicon — design notes
Breakdown of the "Per-feed favicon from the last sender's domain" item above (the parent is P2·M; these sub-tasks are each ~S). Goal: each feed shows an icon derived from its newsletter source, fetched once and cached so it never re-fetches on a normal request.
-
P2·SResolve the sender domain — on ingestion, extract the domain from the latest email'sfromaddress (extractEmailDomaininsrc/utils/favicon-fetcher.ts) and persist it asiconDomainon the feed metadata so the icon tracks the most recent sender. -
P2·SFetch the favicon — resolve an icon URL for the domain: tryhttps://<domain>/favicon.ico, then fall back tohttps://icons.duckduckgo.com/ip3/<domain>.ico. Runs async viactx.waitUntilso it never blocks email processing. -
P2·SCache aggressively — store the fetched bytes (base64) keyed by domain in KV with a 1-week TTL (ICON_TTL_SECONDS). The domain is the cache key so feeds from the same sender share one fetch; the fetch only fires when the cache entry is absent/expired. -
P2·SServe endpoint —GET /favicon/:feedIdreturns the cached bytes with the correctContent-Typeand a longCache-Control, falling back to the project favicon when no domain icon is found. -
P2·SExpose in outputs — the icon is referenced from the RSS<image>and Atom<icon>/<logo>insrc/utils/feed-generator.ts, and rendered next to each feed in the admin list/table (src/routes/admin.tsx). -
P2·SFailure handling — missing/blocked favicons degrade gracefully to the project favicon fallback (negative cache entry); icon fetch errors never surface to ingestion or feed rendering.
Operability, versioning & ecosystem (2026-05-24)
Self-host operational quality-of-life: knowing which version you run, when to update, and how many people run KTN.
-
P3·SDisplay the running version [table-stakes, easy] — surface the deployed app version (frompackage.jsonversion, currently0.2.1) somewhere visible: the admin UI footer and/or the public status page (src/routes/home.tsx), and ideally the/healthJSON. Bundle the version at build time (inline thepackage.jsonversion into the Worker, since there's no filesystem at runtime) and render it. Foundation for the update-notification item below. — Shipped:package.jsonversion is inlined at bundle time viasrc/config/version.ts(import pkg from "../../package.json",resolveJsonModule), exposed asAPP_VERSION; rendered in the shared admin/status footer (src/routes/admin/ui.tsxLayout, so both the status page and admin show it), added to the/healthJSON, and to the canonical monitoring endpoint/api/v1/stats(StatsResponse.version, public). — origin: internal -
P3·MNotify when an update is available [differentiating for self-hosters] — compare the running version against the latest GitHub Release tag and show a discreet "update available → vX.Y.Z" banner in the admin UI when behind. Fetchhttps://api.github.com/repos/<owner>/<repo>/releases/latest(cache aggressively — Cache API / KV with a long TTL — to respect GitHub rate limits and avoid a call per page load), compare semver against the bundled version. Depends on the "display version" item. Keep it opt-out-able (it makes one outbound call). — origin: internal -
P3·LPublic instances directory and/or instance counter (opt-in telemetry) [differentiating, ecosystem] — let a self-hosted instance optionally announce itself to a central registry so we can show a count of live instances (and, if the operator opts in to being listed, a public directory of instances). Each instance periodically pings a central endpoint (on the existing cron) with minimal, opt-in data (e.g. an anonymous instance id + version; a public listing would additionally need a name/URL the operator explicitly provides). ⚠ Privacy-first: off by default, clearly documented, no PII/feed data ever sent; respect "count me but don't list me". Needs a central collector (a separate tiny Worker + KV/DO) plus anINSTANCE_TELEMETRY/INSTANCE_DIRECTORYopt-in env on the client side, fired fromindex.ts'sscheduledhandler. — origin: internal
Epic: Pluggable runtime, storage & ingestion (off-Cloudflare support)
P2·XL Run KTN off Cloudflare from one codebase, adapter-selected by config. Reference non-CF target: Clever Cloud (container + Cellar S3 + a KV/SQL add-on) with Sweego inbound for email. — origin: internal (broader audience / reduced lock-in)
Context / motivation. KTN is Cloudflare-native: Workers runtime, KV + R2 bindings, Email Workers, cron triggers. The v0.2.0 DDD refactor already introduced the seams that make portability tractable — KV access is behind repository adapters (FeedRepository, IconRepository, WebSubSubscriptionRepository, CountersRepository), ingestion is transport-agnostic (processEmail is decoupled from the CF email handler, and a webhook path /api/inbound already exists), HTTP is Hono (runtime-agnostic), and background work is abstracted behind BackgroundScheduler. This epic turns those seams into selectable adapters so KTN can run on a plain Node/container host with non-CF storage and email ingestion.
Goal / outcome. KTN runs on two reference profiles from one codebase:
- A — CF-native (today): Workers + KV + R2 + Cloudflare Email Routing.
- B — Clever+Sweego: Node container + Cellar (S3 blob) + KV-store add-on + Sweego inbound webhook + Node scheduler.
Adapter chosen by config (env), no code change. Same test suite green on both.
Coupling points → adapters.
| Area | CF-native (today) | New adapter (target B) |
|---|---|---|
| Runtime/entrypoint | export default { fetch, email, scheduled } |
Node entrypoint (@hono/node-server) + Dockerfile |
| HTTP | Hono (portable) | Hono (no change; abstract CF-only globals) |
| KV store | KVNamespace binding |
SQL (Postgres/SQLite) or Redis (Materia KV) adapter |
| Blob/attachments | R2Bucket binding |
S3-compatible (Cellar) via aws4fetch/S3 client |
| Email ingestion | CF Email Worker (ForwardableEmailMessage) |
Sweego inbound webhook → /api/inbound |
| Cron cleanup | CF cron trigger | Node scheduler (node-cron) or external trigger |
| Background | ctx.waitUntil (already behind BackgroundScheduler) |
run-and-await Node impl |
| Config/DI | CF bindings on Env |
driver-selection layer (*_DRIVER envs) wiring repos→backends |
Sub-tasks (deliverable independently).
P2·MStorage driver abstraction + config layer — formalize the repository interfaces already implied byFeedRepositoryet al.; add a DI/config layer selecting backends from env. Foundation; no behavior change on CF. — origin: internalP2·MBlob adapter: S3-compatible (Cellar) — put attachments behind aBlobStoreinterface; CF R2 + S3 (aws4fetch, works on Workers and Node). Lowest risk, immediately reusable. — origin: internalP2·LKV-store adapter for self-host — implement the key schema over SQL (recommended: Postgres/SQLite for list-by-prefix semantics) and/or Redis. ⚠ If targeting Materia KV, confirm KTN never relies onRENAME(Materia lacks it — see consumer's ADR-0011); audit the single key schema. — origin: internalP2·LNode runtime entrypoint + container —@hono/node-server, Dockerfile, health endpoint; abstract CF-only globals (caches, reliance onCF-Connecting-IPin proxy-auth → generalize toX-Forwarded-For/trusted-proxy config). — origin: internalP2·LIngestion transport abstraction + Sweego adapter — generalize/api/inboundto provider-agnostic: pluggable payload parser (Sweego JSON →ProcessEmailInput, mirroringparseForwardEmailPayload) + pluggable webhook auth (HMAC signature / shared secret / IP allowlist). Document thatmessage.forward()fallback is CF-Email-Worker-only; on webhook transports, unmatched-mail handling is the provider's concern (Sweego catch-all is isolated to the inbound domain, so the fallback hack isn't needed). — origin: internalP2·MScheduler adapter — makefeed-cleanuprunnable via a Node scheduler or an authenticated/internal/cronendpoint for external triggers. — origin: internalP2·MCI matrix + docs — build/test both targets; INSTALL.md Clever+Sweego profile; deployment guide. — origin: internal
Open questions (resolve before the Sweego adapter sub-task).
- Sweego inbound: webhook auth mechanism (HMAC? signed header? IP list?), JSON payload schema, and attachment delivery (inline base64 vs URLs vs multipart) — drives the parser + how attachments stream into the blob store.
- Clever KV backend choice: Materia KV (Redis, no
RENAME) vs Postgres add-on — decide from the key-op audit in the KV-store sub-task.
Out of scope.
- Running KTN's own SMTP/MTA server (inbound stays delegated: CF Email Routing, Sweego, or ForwardEmail). No port-25 listener.
- Multi-tenant / multi-domain admin.
Acceptance criteria.
- One codebase deploys to both profiles via config only.
- Full vitest suite green on both runtimes.
- Documented end-to-end Clever+Sweego deploy: a newsletter to
noun.noun.NN@<inbound-domain>lands in a feed; attachments served from Cellar; cleanup cron runs. - No regression on the CF-native profile.