0.25.0

[MohamedBassem]

0.25.0

Welcome to the 0.25.0 release of Karakeep! This release addresses a lot of the top most upvoted feature requests. You can now share lists publicly, generate RSS feeds from your lists, reader view & pdf support in the mobile app, bi-directional browser bookmark sync using floccus, maintaining list structure on imports and a lot more. As usual, we have a lot of contributors in this release: @xuatz, @digithree, @thiswillbeyourgithub, @codelove77, @SConaway, @vhsdream, @AdrianAcala, @spasche, @SalGnt, @haappi, @yuikisaito, @jk, @jakeasmith, @Mxrk, @WilliamAGH, and @SteffoSpieler!

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

New Features 🚀

• Public Lists are here: You can now share your curated lists publicly! (feat: Add support for public lists #1511). Example list here.
• RSS Feed Generation: Create and share RSS feeds directly for your lists (feat: Generate RSS feeds from lists #1507)
• Overdue Mobile Improvements:
  • Added reader mode/screenshot/archive views to bookmark previews on mobile (pending app release) (feat(mobile): add reader view by default to bookmark detail view #1509) - @digithree
  • View PDFs directly in the mobile app and share them to karakeep from the share sheet as well (feat(mobile): Add PDF viewing and external opening support #1519, feat(mobile): Add PDF support to share extension #1494) - @codelove77
• Import / Export improvements:
  • Added NETSCAPE file export format support (feat: Add NETSCAPE-Bookmark-file-1 export format support #1374) - @yuikisaito
  • When importing netscape style bookmarks into karakeep, your lists will be re-created on karakeep. Preserving lists from other sources is planned.
  • Preserve archived status when importing from omnivore or pocket (RIP).
• AI Auto-Summarization: Automatic summarization for new bookmarks can be now be enabled with INFERENCE_ENABLE_AUTO_SUMMARIZATION=true (Auto-summarize with AI #1163)
• Floccus Integration: Karakeep now supports bi-directional sync with browser bookmarks using Floccus. This will be available in the next Floccus release within a week or two.

UX Improvements ✨

• The user setting page got fully redesigned to look nicer given that we're starting to have more user settings.
• Tab-based layout for bookmark previews on small screens - @thiswillbeyourgithub
• Save pages faster with a dedicated extension shortcut (feat(extension): add a keyboard shortcut to save page #1532) - @SConaway
• Configure the default behavior when clicking on a bookmark. Either go to source, or expand the details.
• Restored ability to properly sort by creation date for search pages (fix(search): add new relevance sort order #1392) - @xuatz
• You can now decide what you want to do when using the singlefile extension on an existing bookmark. Check out how to customize it here.
• Configure whether you want to see archived bookmarks in lists or tags or not (feat: add user customisable default archive display behaviour #1505) - @xuatz
• Added Algolia-based search to docs
• Added "deleted" webhook event (feat: handle "deleted" webhook events #1464) - @SalGnt
• The Summarize with AI button no longer shows up if you don't have AI configured
• You can now disable auto AI tagging if not needed
• Allow enabling/disabling RSS feeds collection
• Added US English to folks who can't stand the British English - @WilliamAGH
• Improved the positioning of the highlights menu on mobile devices - @Mxrk
• Moved delete button in bookmark menu in the app for better ergonomics

Fixes 🐛

• Started using proper tokenizer for content truncation before inference. This should prevent the truncation of the model prompt leading to better accuracy and instruction adherence.
• Preserve unsaved changes during tag modifications while editing bookmarks (feat: preserve unsaved title changes when modifying bookmark tags #1515) - @AdrianAcala
• Fixed tag drag-and-drop issues on Firefox (Firefox: Drag and Drop Merging does not work #1016) - @haappi
• Added log rotation for linux installations (karakeep-linux.sh fix: use 'append' instead of 'file' for logs #1471) - @vhsdream
• You can now run Karakeep container as a non-root user for better security.

For Developers 🛠️

• Added ?sortOrder parameter for resource sorting (feat(api): enable ?sortOrder= for relevant resources #1398) - @xuatz
• New endpoint for tag creation
• PUT operations for bookmarks are now idempotent (e.g. adding to list) (fix(api): make PUT bookmark to a list idempotent #1427) - @xuatz
• Added PATCH method support to CORS headers (feat: Allow PATCH method in CORS headers #1489) - @spasche
• Documentation:
  • Added documentation for the asset upload APIs
  • Fixed JSON examples in MCP documentation (Fix JSON in MCP documentation #1400, Fixed json syntax error #1419) - @jk, @jakeasmith
  • Expanded Meilisearch upgrade guides (doc: document how to upgrade meilisearch / migrate meilisearch db #1436) - @thiswillbeyourgithub

Community Projects 💡

• Python-based SDK for Karakeep: karakeep-python-api - @thiswillbeyourgithub
• Freshrss Importer: freshrss-to-karakeep - @thiswillbeyourgithub

Screenshots 📸

The Share List Modal

Tabbed Layout on smaller screens

Reader Mode in the app

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.

All Commits

• release(extension): Bump extension version to 1.2.6 - @MohamedBassem in 5b52066
• release(mobile): Bump mobile version to 1.7.0 - @MohamedBassem in 3c48bb8
• ci: Fix manifest formatting - @MohamedBassem in b93f3a4
• feat(mobile): Add support for viewing PDFs (feat(mobile): Add PDF viewing and external opening support #1519) - @codelove77 in 0fde108
• fix(mobile): Move the delete button to the end in the bookmark menu - @MohamedBassem in 421e3e8
• feat(mobile): add reader/screenshot/archive view to bookmark preview (feat(mobile): add reader view by default to bookmark detail view #1509) - @digithree in ec31a97
• fix(build): karakeep-linux.sh fix use 'append' instead of 'file' for log (karakeep-linux.sh fix: use 'append' instead of 'file' for logs #1471) - @vhsdream in 09e5dd6
• feat(extension): add a keyboard shortcut to save page (feat(extension): add a keyboard shortcut to save page #1532) - @SConaway in ee51745
• feat(ui): Improve the look of the public bookmarks page - @MohamedBassem in 3a0f5fa
• fix: Use a new public list metadata endpoint for metadata generation - @MohamedBassem in bc65a73
• docs: Add asset APIs to the openapi spec - @MohamedBassem in a98f023
• fix(web): Smaller card titles in the user info page - @MohamedBassem in 4e481f4
• fix: preserve unsaved title changes when modifying bookmark tags in the edit dialog (feat: preserve unsaved title changes when modifying bookmark tags #1515) - @AdrianAcala in f53ad0a
• feat(web): Redesign the user settings page - @MohamedBassem in 090c0d1
• readme: Small readme fixes - @MohamedBassem in 39feafe
• fix(web): Drop the experimental icon from rss feeds - @MohamedBassem in bf4cbd1
• feat: Drop corepack dep in prod and allow running as non-root. Fixes Add user: "${UID}:${GID}" in compose.yaml #606 - @MohamedBassem in 169e14d
• i18n: Sync weblate translations - 2246083
• Merge remote-tracking branch 'weblate/main' - @MohamedBassem in 7c245aa
• feat: Maintain list structure when importing from netscape. Fixes Retain directory / folder structure while importing HTML export from Chrome (nested bookmarks) #538 - @MohamedBassem in 1bae66f
• feat: Allow specifying the overwrite mode for singlefile archives. Fixes [FR] SingleFile push should overwrite existing archive #1125 - @MohamedBassem in e59be24
• feat: Add support for public lists (feat: Add support for public lists #1511) - @MohamedBassem in ea1d002
• feat: add user customisable default archive display behaviour (feat: add user customisable default archive display behaviour #1505) - @xuatz in 3afe1e2
• docs: mention the list of example scripts for the community api (doc: mention the list of example scripts for the community api #1484) - @thiswillbeyourgithub in 8784c73
• feat(mobile): Add PDF support to share extension (feat(mobile): Add PDF support to share extension #1494) - @codelove77 in 5f47340
• feat: Generate RSS feeds from lists (feat: Generate RSS feeds from lists #1507) - @MohamedBassem in 9695bba
• refactor: Move bookmark utils from shared-react to shared - @MohamedBassem in b218118
• docs: Add agolia based search - @MohamedBassem in 3e860b7
• doc: mention meilisearch in the updating section (doc: mention meilisearch in the updating section #1472) - @thiswillbeyourgithub in 7f04bd1
• feat: Allow PATCH method in CORS headers (feat: Allow PATCH method in CORS headers #1489) - @spasche in 915aeb3
• fix: Fix end icon in smart list input overlapping with text. Fixes Bug(UX): Long smart list queries overlap with the help icon #1379 - @MohamedBassem in d903c7f
• fix: Show list options menu on list sidebar hover - @MohamedBassem in a1f7707
• fix: Truncate the RSS feed url - @MohamedBassem in e0ed727
• chore: Add localhost labs to README and landing - @MohamedBassem in e13809f
• fix(landing): Fix the favicon location for the landing page - @MohamedBassem in 96bce30
• feat: Add "deleted" webhook event (feat: handle "deleted" webhook events #1464) - @SalGnt in 8a927e9
• docs: Update the privacy policy - @MohamedBassem in 37c18b8
• feat: Allow defaulting to reader mode when clicking on bookmarks. Fixes Request: Setting to open content in a "Reader Mode" view by default #662 - @MohamedBassem in 0965217
• docs: Update database docs (doc: Update database docs #1451) - @haappi in 5f3fe5d
• feat: Read the archive status from omnivore and pocket. Fixes Omnivore import improvement - archived #703 - @MohamedBassem in c6d21af
• build: Regen openAPI spec - @MohamedBassem in 6af14e9
• feat: Disable the AI summary button if AI is not configured. Fixes Toggle AI features (tagging and summary) #649 - @MohamedBassem in 8592985
• feat: Add AI auto summarization. Fixes Auto-summarize with AI #1163 - @MohamedBassem in 2743d9e
• feat(api): Expose the endpoint to create a new tag - @MohamedBassem in a5ae67c
• fix(web): Switch to a tab view in small screens for bookmark previews - @thiswillbeyourgithub in 053d1a9
• build: Fix format error - @MohamedBassem in 0e734b6
• fix(web): Fix tag drag and drop merging on firefox .Fixes Firefox: Drag and Drop Merging does not work #1016 (Fixes #1016 #1309) - @haappi in c2e26f9
• refactor: Migrate from NextJs's API routes to Hono based routes for the API (WIP: Migrate from NextJs's API routes to Hono based routes for the API #1432) - @MohamedBassem in 3505cb7
• doc: document how to upgrade meilisearch / migrate meilisearch db (doc: document how to upgrade meilisearch / migrate meilisearch db #1436) - @thiswillbeyourgithub in 74e74fa
• doc: new comunity project: freshrss to karakeep (doc: new comunity project: freshrss to karakeep #1435) - @thiswillbeyourgithub in 3a59293
• feat(api): enable ?sortOrder= for relevant resources (feat(api): enable ?sortOrder= for relevant resources #1398) - @xuatz in 4e06ea7
• fix: Use proper tokenizer when truncating for inference. Fixes Ollama prompt gets truncated with custom rules #1405 - @MohamedBassem in 70d5720
• feat: position highlight menu based on device type (feat: position highlight menu based on device type #1348) - @Mxrk :) in 523a251
• fix(search): add new relevance sort order (fix(search): add new relevance sort order #1392) - @xuatz in dbd0fd1
• fix(api): make PUT bookmark to a list idempotent (fix(api): make PUT bookmark to a list idempotent #1427) - @xuatz in f338f7b
• build(Debian): update yt-dlp on karakeep's update and add a service check function (build(Debian): add mcp build; use nightly yt-dlp build; update system #1329) - @vhsdream in 4ae5857
• doc: Mention karakeep-python-api in community projects (doc: mention karakeep-python-api in community projects #1424) - @thiswillbeyourgithub in 60f4712
• docs: minor update to dev setup instructions (docfix: minor: dev setup instructions #1421) - @thiswillbeyourgithub in 65d7096
• fix(landing): Fix the responsiveness of the landing page - @MohamedBassem in d44cd23
• docs: Update pikapods docs after the rename - @MohamedBassem in 6f6c987
• feat: Allow enabling/disabling RSS feeds - @MohamedBassem in 370db08
• feat: Add karakeep metadata to openai calls - @MohamedBassem in 2a8d4b8
• doc: Fixed json syntax error in mcp docs (Fixed json syntax error #1419) - @jakeasmith in 2082f87
• docs: Fix JSON in MCP documentation (Fix JSON in MCP documentation #1400) - @jk in 3ececfc
• feat: Add NETSCAPE-Bookmark-file-1 export format support (feat: Add NETSCAPE-Bookmark-file-1 export format support #1374) - @yuikisaito in c03dcfd
• fix(mcp): Correct description for get-lists tool. Fixes get-lists tool has wrong description #1332 (Fix: Correct description for get-lists tool #1388) - @MohamedBassem in 8b05515
• i18n: Add US English as option in User Settings (Feature: Add US English as option in User Settings #1327) - @WilliamAGH in 3d802db
• docs: Update the docs about admin password reset to include the salt - @MohamedBassem in 3b246a8
• fix(docker): Fix build only docker compose file - @MohamedBassem in f4a3156

---

This discussion was created from the release 0.25.0.