0.26.0

[MohamedBassem]

0.26.0

Welcome to the 0.26.0 release of Karakeep! This release focuses on user management, servers improvements, and lots of fixes. We've a new comprehensive usage stats, reader mode, search history, S3 support, and much more. As always, we have amazing contributors in this release: @xuatz, @Ashok28, @HarryPeach, @Mostafa-Wahied, @adumat, @alexjsp, @apo-mak, @birnam, @deepanshu2711, @hametovbr, @irobot, @kdwils, @lexafaxine, @maelp, @rodsnts, @sheyabernstein, @simplytoast1, @thiswillbeyourgithub, @vhsdream!

If you enjoy using Karakeep, consider supporting the project here ☕️ or via GitHub here.

Managed Karakeep ☁️

I have some news to share! With Pocket shutting down, I've been thinking about how to make Karakeep more accessible to a wider audience. So I've decided to start the journey of offering a managed karakeep instance to serve those who can't selfhost.
Karakeep wouldn't be where it is today without its amazing self-hosting community, and that will always remain my first priority. This managed offering is just an experiment. If it works, it could help support the development of the project. We're now starting a private beta, and you can join the waitlist here!

New Features 🚀

• User Management & Authentication:
  • Added email verification support for new user registrations
  • Implemented password reset and forgot password functionality
  • Added user invitation system
  • Revamped signin/signup pages with better UX
  • Added per-user bookmark count / storage quotas
  • New delete account feature for users who want to remove their data
• Search History: You'll now get search suggestions from your karakeep search history (feat: #1541 adding search history #1627 by @lexafaxine)
• File Upload Support: Added markdown file upload support (feat: markdown file upload support (#1647) #1672 by @rodsnts)
• Usage Statistics: New user stats page showing tons of stats about your bookmarks and usage of karakeep (FR: a user "statistics" page #1523)
• New Reader Mode: A new revamped reader mode with customizable font type and size (got jealous of how that of linkwarden looked!)
• Proxy Support: Added proper proxy support for crawler network requests (Proxy for Chrome not working anymore #1265)
• Server Improvements:
  • S3 Storage Support: Option to store assets in S3-compatible storage (feat: Add support for S3 as an asset storage layer #1703)
  • Prometheus Monitoring: We're now exposing a Prometheus endpoint for monitoring stats about the server (Add prometheus metrics #758)
  • Rate Limiting: Added optional API rate limiting
  • Large HTML content now stored in asset storage (instead of db) for better performance
  • Allow enabling WAL mode on the database (opt-in, recommended)
  • Allow customizing parallelism for workers (Allow parallel inference #724)
• Reddit Crawling: Reddit posts will now get a more relevant banner image (feat (workers): adding a local metascraper plugin for Reddit posts #1302 by @birnam)

UX Improvements ✨

• Prioritize crawling user-added links over bulk imports (Newly added items should go to the front of the background jobs #1717)
• Mobile app now has user setting for default bookmark view mode (feat(mobile): Add user setting for default bookmark view mode #1723 by @xuatz)
• More lenient JSON parsing for LLM responses (FR: A more lenient JSON parsing (allow markdown parsing) in inference structured calls #1267)
• Tweaks to mobile app icon padding with iOS tinted variant (fix: tweaks to mobile app icon padding + added iOS tinted variant #1620 by @alexjsp)
• Minor styling changes to the "All Tags" page
• Added icons to bookmark preview selectors
• Clicking on search tooltip now opens the search language guide (FR: add a "help" button for the query language #1540)
• Added confirmation dialog for user deletion in admin panel (feat(admin): add confirmation dialog for user deletion (#1648) #1649 by @deepanshu2711)
• Added tag clearing functionality to tag list in the mobile app(feat: Clear all tags on mobile #1595 by @Ashok28)
• Always visible search bar in the mobile app's tags list (UI Fix: Immediately visible search bar in tags list #1596 by @Ashok28)

Fixes 🔧

• Fixed OAuth creation failure due to missing UserSettings table (OAuth user creation might be broken #1583)
• Fixed webhook not firing on deletion ([BUG] Deletion webhook doesn't get fired as expected #1613)
• Normalized leading hashes in tag names (fix(tags): normalise leading hashes in tag names (#1317) #1351 by @Mostafa-Wahied)
• Fixed import/export icons being swapped (fix: switch import / export icons #1682 by @HarryPeach)
• Disabled metascraper readability plugin that was causing worker stuckness
• Fixed jsdom console logs leaking into worker logs
• Collapsed long runs of repeated whitespaces before tokenization to speed it up ([BUG] Inference task that takes a really long time to pre-process (>10 minutes) caused by slow tokenization #1622)
• Fixed public image signed tokens for better caching
• Fixed clear parent button in edit list dialog ('Edit List' behaviour #1742)
• Fixed running workers in production without tsx for lower resource usage (release Docker image runs with tsx index.ts (development mode), causing high CPU usage and poor performance #1673)
• Fixed get-lists MCP tool (fix: add empty params object to lists function in mcp #1697 by @hametovbr)
• Fixed image quality slider in mobile showing excessive decimal places ([iOS App] Image Quality Slider stuck at 28.999999....6% after double tapping #1735)
• Fixed mobile app crash when bookmark doesn't have archive or screenshot (Android app crashes on "archive" view #1584)
• Migrated from Puppeteer to Playwright (Feat/playwright only #1296 by @maelp)
• Video downloader now properly logs yt-dlp errors (fix(workers): video downloader should log yt-dlp errors #1624 by @irobot)

For Developers 🛠️

• Added Helm chart support (link). (feat: Add Helm chart #1350 by @sheyabernstein)
• Build & Deployment:
  • A much fancier linux installation script (karakeep-linux.sh v3.0 - Bling version #1576 by @vhsdream)
  • Added start-dev.sh script for easier development (chore: add start-dev.sh for laziness #1628 by @xuatz)
  • Upgraded to [email protected] (feat: upgrade to [email protected] #1544 thanks to @xuatz)
  • Migrated from ESLint to oxlint for faster linting (chore: migrate away from eslint to oxlint #1642 by @xuatz)
  • We now have a CLAUDE.md file to help the vibe coders out there.

Community Projects 💡

Karakeeper

3rd Party Safari Extension - by @simplytoast1

Karakeep Homedash

by @CodeJawn

Screenshots 📸

Usage Stats

The new Sign In page

Recent Searches

Reader Mode

Upgrading 📦

To upgrade:

• If you're using KARAKEEP_VERSION=release, run docker compose pull && docker compose up -d.
• If you're pinning it to a specific version, upgrade the version and then run docker compose pull && docker compose up -d.

Note: This release includes database schema changes. The migration will run automatically on startup.

All Commits

• fix(web): Remove horizontal scroll in PWA's header - @MohamedBassem in 202924c
• feat(web): Slightly nicer looking tags page - @MohamedBassem in 61a6ac8
• fix: Run workers in prod without tsx. Fixes release Docker image runs with tsx index.ts (development mode), causing high CPU usage and poor performance #1673 - @MohamedBassem in 2cce45b
• deps: bump s6-overlay version (bump s6-overlay version to v3.2.1.0 #1750) - @adumat in 4fe541c
• fix: Fix edit list modal not clearing parent - @MohamedBassem in b992fad
• feat: Add a proper reader mode - @MohamedBassem in 49f38ef
• fix: Increase crawler max worker count in tests - @MohamedBassem in 4a4ff37
• feat: Allow setting browserless crawling per user - @MohamedBassem in 4e9544b
• feat: Allow enabling journaling mode on the db - @MohamedBassem in 64a0d91
• fix(mobile): Fix image quality slider showing lots of decimal places. fixes [iOS App] Image Quality Slider stuck at 28.999999....6% after double tapping #1735 - @MohamedBassem in ae1352f
• fix: Rename the proxy settings such that they don't interfer with other requests - @MohamedBassem in 1da8b45
• chore: Move the helm charts to their own repo - @MohamedBassem in f3feb59
• fix(web): Fix the clear parent button in the edit list dialog. Fixes 'Edit List' behaviour #1742 - @MohamedBassem in 8bd3b58
• feat(mobile): Add user setting for default bookmark view mode (feat(mobile): Add user setting for default bookmark view mode #1723) - @xuatz in fe69ca8
• fix: Clear search history on logout - @MohamedBassem in a362756
• feat: adding search history FR: search history #1541 (feat: #1541 adding search history #1627) - @lexafaxine in 39fcda0
• feat: markdown file upload support (Support for uploading and rendering Markdown (.md) files in Karakeep #1647) (feat: markdown file upload support (#1647) #1672) - @rodsnts in ecb13ce
• Revert "fix: Fix the types of the bookmark types in the db query" - @MohamedBassem in 0addc7b
• fix: Fix the types of the bookmark types in the db query - @MohamedBassem in 4ba3e80
• feat: Add stripe based subscriptions - @MohamedBassem in d1d5263
• feat: Add delete account support - @MohamedBassem in 845ccf1
• fix: Drop auth failure logger - @MohamedBassem in f8ae986
• feat: Add proper proxy support. fixes Proxy for Chrome not working anymore #1265 - @MohamedBassem in 360ef9d
• feat(api): Expose the update user API in the openapi specs - @MohamedBassem in 1105b4a
• build: Restrict claude actions invocations - @MohamedBassem in ba7a87f
• fix(web): Fix the alignment in the user options page - @MohamedBassem in 49648c4
• deps: Upgrade typescript to 5.8 - @MohamedBassem in 6b77736
• fix: Add ratelimiting to bookmark recrawl and summarization - @MohamedBassem in 21076b8
• deps: Upgrade drizzle - @MohamedBassem in f4436e1
• fix(web): Fix dark mode in auth pages - @MohamedBassem in 9231119
• fix(tests): Fix missing mock in trpc tests - @MohamedBassem in 8c3bf48
• fix: Prioritize crawling user added links over bulk imports. fixes Newly added items should go to the front of the background jobs #1717 - @MohamedBassem in 9fb3ef6
• refactor: Move db interactions into the trpc routes - @MohamedBassem in 8e3013b
• feat: Support forget and reset password - @MohamedBassem in 140311d
• chore: Add claude code github action - @MohamedBassem in 385f9f0
• feat(ui): Revamp the signin/signup page - @MohamedBassem in db9a02b
• feat: Add API ratelimits - @MohamedBassem in 613137f
• feat: Add invite user support - @MohamedBassem in 333d161
• feat: Add support for email verification - @MohamedBassem in 93049e8
• fix(api): Fix handling for CORS after the trpc move to hono. Fixes NetworkError when attempting to fetch resource with Firefox addon #1709 - @MohamedBassem in aae3ef1
• fix: Drop the need to for the self-call for providers and NEXTAUTH_INTERNAL_URL - @MohamedBassem in f7f577a
• feat: Add a logout page - @MohamedBassem in bb4a687
• fix: Add a dummy bcrypt comparison in validatePassword when the user is not found - @MohamedBassem in 58488e1
• build: Add an open-api husky check - @MohamedBassem in 7145816
• fix(build): Regenerate openapi spec - @MohamedBassem in 0eeefd6
• fix: Fix search indexing after content split - @MohamedBassem in f5a674c
• fix(web): Clicking on search tooltip opens the search language guide. Fixes FR: add a "help" button for the query language #1540 - @MohamedBassem in f3b925a
• feat: Store large html content in the asset db - @MohamedBassem in dee3a4d
• fix(mobile): Fix crash when bookmark doesn't have archive or screenshot. Fixes Android app crashes on "archive" view #1584 - @MohamedBassem in 362be30
• fix(tests): Fix broken user setting test - @MohamedBassem in 959da9a
• chore: Excluded unneeded docker context using dockerignore - @MohamedBassem in 5c8a2b9
• feat: Add a new timezone user setting - @MohamedBassem in 0e94ad3
• feat: Add prometheus monitoring. Fixes Add prometheus metrics #758 - @MohamedBassem in b60ece5
• fix(build): Regenerate openapi spec - @MohamedBassem in cfa0385
• fix: Fix i18n in the new stats page - @MohamedBassem in f96680f
• feat: Add per user storage quota - @MohamedBassem in 384432d
• feat: Add new user stats page. Fixes FR: a user "statistics" page #1523 - @MohamedBassem in 4762454
• feat(workers): Allow custmoizing max parallelism for a bunch of workers. Fixes Allow parallel inference #724 - @MohamedBassem in 5576361
• feat: Add support for S3 as an asset storage layer (feat: Add support for S3 as an asset storage layer #1703) - @MohamedBassem in d66b3b8
• fix(workers): A more lenient JSON parsing for LLM responses. Fixes FR: A more lenient JSON parsing (allow markdown parsing) in inference structured calls #1267 - @MohamedBassem in 53b6b3c
• refactor: Move the health endpoint to hono as well - @MohamedBassem in f144f1b
• refactor: Move the trpc endpoint to hono - @MohamedBassem in f5e737b
• chore: Symlink Gemini.md to CLAUDE.md - @MohamedBassem in 474ca7f
• feat: Add per user bookmark count quota - @MohamedBassem in 545cac1
• chore: Symlink Gemini.md to AGENTS.md - @MohamedBassem in 73a0c95
• fix(web): Add icons to preview selectors - @MohamedBassem in ad92fa2
• chore: Add a GEMINI.md file for people using gemini-cli - @MohamedBassem in 4776b4c
• fix(mcp): add empty params object (fix: add empty params object to lists function in mcp #1697) - @hametovbr in 6cc249d
• fix: switch import / export icons (fix: switch import / export icons #1682) - @HarryPeach in 7febebe
• fix(workers): Disable the metascraper readability as it's causing slowness in worker - @MohamedBassem in 71f8e97
• fix(workers): Fix jsdom console logs leaking into worker logs - @MohamedBassem in b74377d
• feat(workers): adding a local metascraper plugin for Reddit posts (feat (workers): adding a local metascraper plugin for Reddit posts #1302) - @birnam in 7cc4b08
• fix(tags): normalise leading hashes in tag names (Prevent the creation of '##test' hashtag #1317) (fix(tags): normalise leading hashes in tag names (#1317) #1351) - @Mostafa-Wahied in 112aa9d
• feat(workers): migrate from puppeteer to playwright (Feat/playwright only #1296) - @maelp in c70d64d
• feat(mobile): Add tag clearing functionality to tag list (feat: Clear all tags on mobile #1595) - @Ashok28 in 727c7f2
• fix(mobile): always visible search bar in tags list (UI Fix: Immediately visible search bar in tags list #1596) - @Ashok28 in 4134649
• fix: minor changes to the tagging prompts (feat: add optional thinking key to tagging response schema + other prompt enhancements #1474) - @thiswillbeyourgithub in a74afc9
• build: Install script v3.0 - Bling version (karakeep-linux.sh v3.0 - Bling version #1576) - @vhsdream in e310ba9
• feat: Add Helm chart (feat: Add Helm chart #1350) - @sheyabernstein in 43d3210
• chore: More oxlint changes - @MohamedBassem in f7b3193
• chore: migrate away from eslint to oxlint (chore: migrate away from eslint to oxlint #1642) - @xuatz in d5e2973
• docs: update meilisearch key generation instruction (Feature/meili master key updated example #1651) - @kdwils in 91a9d3c
• fix: Fix webhook not firing on deletion. Fixes [BUG] Deletion webhook doesn't get fired as expected #1613 - @MohamedBassem in 04f9394
• feat(admin): add confirmation dialog for user deletion ([FR] Add a confirmation dialog to user deletion in the admin panel #1648) (feat(admin): add confirmation dialog for user deletion (#1648) #1649) - @deepanshu2711 in 0f4c616
• fix: Collapse long runs of repeated whitespaces before tokenization to avoid choking the tokenizer. Fixes [BUG] Inference task that takes a really long time to pre-process (>10 minutes) caused by slow tokenization #1622 - @MohamedBassem in 426beff
• fix: Change public image's signed tokens to be time aligned for better caching - @MohamedBassem in 10d45e8
• fix: Fix oauth creation failure due to missing UserSettings table. Fixes OAuth user creation might be broken #1583 - @MohamedBassem in f1f665f
• fix(mobile): tweaks to mobile app icon padding + added iOS tinted variant (fix: tweaks to mobile app icon padding + added iOS tinted variant #1620) - @alexjsp in 6c0bcca
• fix(workers): video downloader should log yt-dlp errors (fix(workers): video downloader should log yt-dlp errors #1624) - @irobot in a16c542
• chore: add start-dev.sh for laziness (chore: add start-dev.sh for laziness #1628) - @xuatz in 88e4ea9
• i18n: Add Greek translation (Add Greek translation #1564) - @apo-mak in 004eb5a
• docs: Mention the community safari extension in the quick sharing docs (Update 05-quick-sharing.md #1562) - @simplytoast1 in e5307f1
• release(cli): Bump CLI version to 0.25.0 - @MohamedBassem in bb00699
• build: Pin ios github action to macos-15 to comply with apple's requirement for min ios SDK - @MohamedBassem in d7617cc
• fix: Fix UI infinite recursion by upgrading radix packages - @MohamedBassem in 675ed5c

---

This discussion was created from the release 0.26.0.

[thiswillbeyourgithub]

Note for others: to enable WAL mode for the sqlite db: set the env variable DB_WAL_MODE to true.

source:

karakeep/docs/docs/03-configuration.md

Line 17 in 298b347

| DB_WAL_MODE | No | false | Enables WAL mode for the sqlite database. This should improve the performance of the database. There's no reason why you shouldn't set this to true unless you're running the db on a network attached drive. This will become the default at some time in the future. |

[Eragos]

Some documentation for SQLite WAL → Write-Ahead Logging