A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search
docs: source control the release notes in the repo
Mohamed Bassem5ee3422f8487
diff --git a/release-notes/2024-02-20-v0.1.0.md b/release-notes/2024-02-20-v0.1.0.mdnew file mode 100644index 00000000..5d67fa9c--- /dev/null+++ b/release-notes/2024-02-20-v0.1.0.md@@ -0,0 +1,2 @@+# 0.1.0+diff --git a/release-notes/2024-02-22-v0.2.0.md b/release-notes/2024-02-22-v0.2.0.mdnew file mode 100644index 00000000..391b8fe5--- /dev/null+++ b/release-notes/2024-02-22-v0.2.0.md@@ -0,0 +1,2 @@+# 0.2.0+diff --git a/release-notes/2024-02-22-v0.2.1.md b/release-notes/2024-02-22-v0.2.1.mdnew file mode 100644index 00000000..5d487366--- /dev/null+++ b/release-notes/2024-02-22-v0.2.1.md@@ -0,0 +1 @@+Minor UI tweaks and fixing the addition of the first link.diff --git a/release-notes/2024-02-22-v0.2.2.md b/release-notes/2024-02-22-v0.2.2.mdnew file mode 100644index 00000000..313f4ad8--- /dev/null+++ b/release-notes/2024-02-22-v0.2.2.md@@ -0,0 +1,2 @@+fix: Tag filtering and sorting+fix: Remove the separator line from the sign in page when no providers are configureddiff --git a/release-notes/2024-02-26-v0.3.0.md b/release-notes/2024-02-26-v0.3.0.mdnew file mode 100644index 00000000..c41a329c--- /dev/null+++ b/release-notes/2024-02-26-v0.3.0.md@@ -0,0 +1 @@+feat: Add support for adding/removing tags from an existing bookmarkdiff --git a/release-notes/2024-02-27-v0.3.1.md b/release-notes/2024-02-27-v0.3.1.mdnew file mode 100644index 00000000..8dc85fb9--- /dev/null+++ b/release-notes/2024-02-27-v0.3.1.md@@ -0,0 +1 @@+fix the docker image to run the migrations at startupdiff --git a/release-notes/2024-02-28-v0.4.0.md b/release-notes/2024-02-28-v0.4.0.mdnew file mode 100644index 00000000..24a2a491--- /dev/null+++ b/release-notes/2024-02-28-v0.4.0.md@@ -0,0 +1 @@+Main feature: Add support for storing markdown notesdiff --git a/release-notes/2024-02-29-v0.4.1.md b/release-notes/2024-02-29-v0.4.1.mdnew file mode 100644index 00000000..d72327c1--- /dev/null+++ b/release-notes/2024-02-29-v0.4.1.md@@ -0,0 +1,8 @@+Mostly minor UI improvements++[fix: Prevent openai from inferring tags from the prompt itself](https://github.com/MohamedBassem/hoarder-app/commit/123351179cb6b916729b17ca1eb95937cd475033)+[fix: Delete URL on successful bookmark](https://github.com/MohamedBassem/hoarder-app/commit/34c3498144e136fbe1d60281ad54111c02ab5b79)+[fix: Fix the look of the grid view and allowing notes to have variable size](https://github.com/MohamedBassem/hoarder-app/commit/f8cef28758a2b331a8acad499dfbd92e9794fcc5)+[fix: Fix phantom links in tag pills](https://github.com/MohamedBassem/hoarder-app/commit/045c09bed91170920b33eaecfef9a6a49a4ec4ad)+[fix: Change the colors of the tag pill](https://github.com/MohamedBassem/hoarder-app/commit/a251292b138fc5bbf37449f759abc05fa2117fe7)+[fix: Open links in new tab](https://github.com/MohamedBassem/hoarder-app/commit/900d576c54f8ee734a9652dcc2e30ced480408a2)diff --git a/release-notes/2024-03-01-v0.5.0.md b/release-notes/2024-03-01-v0.5.0.mdnew file mode 100644index 00000000..6cbbb2d0--- /dev/null+++ b/release-notes/2024-03-01-v0.5.0.md@@ -0,0 +1,3 @@+feature: Add support for lists+feature: Add full text search support+feature: Add a server admin pagediff --git a/release-notes/2024-03-05-v0.6.0.md b/release-notes/2024-03-05-v0.6.0.mdnew file mode 100644index 00000000..765292c6--- /dev/null+++ b/release-notes/2024-03-05-v0.6.0.md@@ -0,0 +1,7 @@+[feature: Preview page for the stored content of links](https://github.com/MohamedBassem/hoarder-app/commit/b8b0a444139358bdf7707034e3a7437babc69db8)+[fix: Use puppeteer adblocker to block cookies notices](https://github.com/MohamedBassem/hoarder-app/commit/591358c5a54919b7b8fc0819679c11ffe1d3472e)+[fix: Teach openai to ignore cookie consent popups](https://github.com/MohamedBassem/hoarder-app/commit/12a6808f6d301210ab9e71dbe1532cedac4e8320)+[feature: Initial attempt at making the app a PWA](https://github.com/MohamedBassem/hoarder-app/commit/19f17b497a5f6a7619af9d099243af337e8fce5e)+[feature: Add an 'All Lists' page](https://github.com/MohamedBassem/hoarder-app/commit/cd623ad9d6281389b0a092520c777567fcf5464b)+[feature: Show a loading indicator when tags are still being fetched](https://github.com/MohamedBassem/hoarder-app/commit/e5bedae5eaad8ed377e7d9b689815dbd55fdb523)+[feature: Make the first user an admin automatically](https://github.com/MohamedBassem/hoarder-app/commit/b7b5306619cc4420bd0ae494881ee7161391dec4)diff --git a/release-notes/2024-03-21-v0.7.0.md b/release-notes/2024-03-21-v0.7.0.mdnew file mode 100644index 00000000..67ed70d3--- /dev/null+++ b/release-notes/2024-03-21-v0.7.0.md@@ -0,0 +1,11 @@+- A new mobile app got introduced+- Now it's possible to hoard images and get them auto tagged+- The bookmark preview page got revamped+- An inline editor card to replace the nav bar buttons+- Fix flicking in search which makes feel much smoother now. Also reduced the debounce duration for faster reaction time.+- Added missing indicies to the db.+- The bookmark grid is now paginated.+- A new revamped tags editor+- A new landing page at https://hoarder.app+- Add support for removing items from lists.+- We're now publishing both macos and linux docker imagesdiff --git a/release-notes/2024-03-24-v0.8.0.md b/release-notes/2024-03-24-v0.8.0.mdnew file mode 100644index 00000000..faca2a7c--- /dev/null+++ b/release-notes/2024-03-24-v0.8.0.md@@ -0,0 +1,2 @@+- web: Add night mode support+- docker: Run chrome in its own containerdiff --git a/release-notes/2024-03-26-v0.9.0.md b/release-notes/2024-03-26-v0.9.0.mdnew file mode 100644index 00000000..63f82284--- /dev/null+++ b/release-notes/2024-03-26-v0.9.0.md@@ -0,0 +1,6 @@+It's announcement day ππ++- The browser now runs in its own container which resulted into a smaller overall image sizes.+- We have a [new logo](https://github.com/MohamedBassem/hoarder-app/blob/main/screenshots/logo.png). This release updates the logo everywhere.+- Allow showing demo mode creds in sign in page.+- Minor UI fixesdiff --git a/release-notes/2024-03-27-v0.10.0.md b/release-notes/2024-03-27-v0.10.0.mdnew file mode 100644index 00000000..373924fb--- /dev/null+++ b/release-notes/2024-03-27-v0.10.0.md@@ -0,0 +1,8 @@+Main features:+- Local LLM support via ollama. Check the [configuration docs](https://docs.hoarder.app/configuration#inference-configs-for-automatic-tagging) for how to set it up.++Other minor fixes:+- Drop CORS restrictions on the API because it is actually intended to be used cross origins).+- Fix the "Favourites" typo in the sidebar.+- Allow specifying a specific redis database index to use instead of the default `0` one.+- Document the `DISABLE_SIGNUPS` flag.diff --git a/release-notes/2024-03-27-v0.10.1.md b/release-notes/2024-03-27-v0.10.1.mdnew file mode 100644index 00000000..e83faa38--- /dev/null+++ b/release-notes/2024-03-27-v0.10.1.md@@ -0,0 +1,9 @@+Mostly a lot of minor fixes:++- Fix: Attempt to increase the reliability of the ollama inference by working around some of the errors in the ollama package.+- Fix: There was a limit of 2k chars on notes. This is no longer there.+- Fix: When a bookmark is deleted in the search page, it wasn't getting removed from the grid. This is now fixed.+- feature: In the editor card, you can now save the bookmark by pressing `Ctrl + Enter` as well as the `Cmd + Enter`. This should be more intuitive to windows users.+- feature: You can now upload webp images.+- feature: Maximum asset size was 4MB. Now it's configurable with the `MAX_ASSET_SIZE_MB` env variable. This variable still defaults to 4MB.+- ui: Red destructive color looks slightly better now in dark mode.diff --git a/release-notes/2024-04-02-v0.11.0.md b/release-notes/2024-04-02-v0.11.0.mdnew file mode 100644index 00000000..ff3e4ced--- /dev/null+++ b/release-notes/2024-04-02-v0.11.0.md@@ -0,0 +1,45 @@+Welcome to the v0.11.0 release of Hoarder. This packs a bunch of new stuff and fixes.++## New Features+- There's now a CLI tool to enable mass manipulations for your bookmarks. You can use it, for example, to mass import bookmarks from your previous tool. Check its docs [here](https://docs.hoarder.app/command-line), and you can check the initial version of importing bookmarks docs [here](https://docs.hoarder.app/import).+- You can now attach notes to your bookmarks.+- You can now delete tags in the tag view page.+- The `All Tags` page now differentiates between manually attached tags and AI attached tags.+- You can specify the language of the auto generated tags with `INFERENCE_LANG=<lang>` env variable. It currently defaults to `english`. Thanks @COOHU-Kr for the suggestion!+- The web UI now allows uploading multiple images at the same time. `Webp` support also got added.+- Clicking `β + E` or (`ctrl + E`) will now focus on the new bookmark editor. Thanks @chanunnaki for the idea!+- Current server version is now shown in the admin panel. It'll also check github API to know if there are new version. You can disable the new version check with `DISABLE_NEW_RELEASE_CHECK=true`.+- In case you missed it, the android app is almost there (under google's mercy). If you can't wait, you can download the APK from [this issue](https://github.com/MohamedBassem/hoarder-app/issues/6)++## Fixes+- Search results are now sorted by relevance.+- In some rare instances, the crawler was getting stuck parsing some pages preventing any other links from getting crawled. There's now a 30s timeout to solve this problem.+- Fix the `sharp is missing` error in the `web` container logs.+- When logging out, people were getting redirected to `localhost:3000` by mistake. Add `NEXTAUTH_URL=<server_url>` to your env file to fix that. The installation docs has been updated.++## Upgrade+- [Optional but hightly recommended] The initial docker compose was using an old chrome version (`v100`). Bump the chrome container version to `v123` by changing the chrome container image:+ - from: `gcr.io/zenika-hub/alpine-chrome:100`+ - to: `gcr.io/zenika-hub/alpine-chrome:123`+- If you're using `HOARDER_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`.+++## Some screenshots from the release++### The new `All Tags` page++<img width="1292" alt="Screenshot 2024-04-02 at 5 20 16β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/b99850e0-25e6-4b99-aaf6-f9ae0977731f">++### Attaching notes to bookmarks+<img width="363" alt="Screenshot 2024-04-02 at 5 20 49β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/f6ac2a64-2c16-45d4-9987-8e536c35e438">++### Server version in admin panel+<img width="514" alt="Screenshot 2024-04-02 at 5 20 28β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/7605f9c2-3196-4d52-a081-9ef72a541b0d">++### The new CLI+<img width="758" alt="Screenshot 2024-04-02 at 5 24 25β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/0106253f-276d-47d4-8b5c-58061fd56d16">++++diff --git a/release-notes/2024-04-03-v0.11.1.md b/release-notes/2024-04-03-v0.11.1.mdnew file mode 100644index 00000000..8d144a2c--- /dev/null+++ b/release-notes/2024-04-03-v0.11.1.md@@ -0,0 +1,4 @@+This is a small hotfix release for v0.11.0.++5ef2efe fix: Incorrect counts for tags in the AllTags page. Fixes #78+diff --git a/release-notes/2024-04-15-v0.12.0.md b/release-notes/2024-04-15-v0.12.0.mdnew file mode 100644index 00000000..ee6ca5a4--- /dev/null+++ b/release-notes/2024-04-15-v0.12.0.md@@ -0,0 +1,44 @@+Welcome to the `0.12.0` release of hoarder! This release is special because we have our first full feature contribution by @AhmadMuj. Welcome to the contributors list @AhmadMuj! If you're interested in helping us develop hoarder, you can join the new `#development` channel on [hoarder's discord](https://discord.gg/NrgeYywsFh).++## New Features++- Raspberry Pi support is now here!+- You can now upload pdfs and get them indexed and automatically tagged thanks to @AhmadMuj!+- You can now change the layout of the bookmark list. We're starting with three layouts:+ - `Masonry` which was the layout used before that release.+ - `Grid` where every card has a fixed height resulting in a strict grid.+ - `List` which shows all bookmarks under each other in a list (screenshot attached later in the release notes).+- Previously, you were only allowed to upload items from the homepage. Now you can upload directly in a list, tag or even the favourited/archived list.+- Previously, the admin panel only allowed you to recrawl all bookmarks. @AhmadMuj added support for only crawling the failed ones (and showed some stats about them there as well).+- The default OpenAI image model got upgraded to the new `gpt-4-turbo` which should be more robust and accurate while costing the same.+- You can now add titles to bookmarks (and edit existing ones). Uploaded assets (images and pdfs) now automatically get their filename as a title. A new bookmark action bar got added to the bookmark preview page.++## Changes in Behavior+- Previously, archived items were hidden from almost everywhere except the archived list which made it not very different from just deleting the item. Starting from this release, `archived` items are only hidden from the homepage but will continue appearing in lists, search, etc. This is more aligned with other bookmark managers (e.g. pocket). With this change, you can now use `archiving` to achieve `Inbox Zero` on your homepage by archiving the items that no longer require your attention or articles that you've already read.++## Fixes+- Crawling robustness:+ - Default crawling timeout increased from `30s` to `60s` and default navigation timeout increase from `10s` to `30s`. Both can now be controlled with the env variables `CRAWLER_JOB_TIMEOUT_SEC` and `CRAWLER_NAVIGATE_TIMEOUT_SEC` respectively. You might want to increase them further if you're running hoarder on a low-perf machine or have a slow internet connection.+ - Crawling jobs are now retried 5 times before giving up on them.+ - Crawler error messages are now more descriptive to help debug issues.+- You no longer need to refresh the `All tags` page when tags are changed.+- When a user is deleted, their on disk assets were not correctly deleted. This is now fixed.+- Fixed error when adding notes with a colon in the first word.++## Screenshots of the new features++### The new action bar in the preview page along with the new support for editing titles.+<img width="378" alt="Screenshot 2024-04-15 at 8 19 31β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/d34b8bbf-b15f-4644-a1ca-7b63aa356baa">++### The new `List` view and its toggles.+<img width="380" alt="Screenshot 2024-04-15 at 8 18 54β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/f1e6548b-2db0-4387-be2e-69585960938b">+<img width="1050" alt="Screenshot 2024-04-15 at 8 19 06β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/b5a6d17f-590e-41fb-8544-8b9decebad3c">++### PDF support+<img width="341" alt="Screenshot 2024-04-15 at 8 33 36β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/a7839791-8fa8-4e7b-8322-98daa0464a36">++++## Upgrade+- If you're using `HOARDER_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`.diff --git a/release-notes/2024-04-15-v0.12.1.md b/release-notes/2024-04-15-v0.12.1.mdnew file mode 100644index 00000000..760f60ef--- /dev/null+++ b/release-notes/2024-04-15-v0.12.1.md@@ -0,0 +1,9 @@+This is a small hotfix for the [0.12.0 release](https://github.com/MohamedBassem/hoarder-app/releases/tag/v0.12.0).++- fix: Fix slice call in the content truncation logic which was resulting in excessive usage of context tokens. Fixes #94 by @MohamedBassem in #4629dac++The bug fixed in this release resulted into mistakingly truncating the first 1500 words in large contents during tag inference (instead of taking only the first 1500 words). This had two side effects for bookmarks with a lot of content (> 1500 words):+1. Due to the truncation of the first 1500 words, you might have got some sub optimal tags for content with >1500 words.+2. For bookmarks with huge content size, you might have got inference failures due to hitting the context limits of the models you're using. And for the ones that were under the context size, they might have taken longer and used more credits than intended.++If this is a problem for you, you can trigger a re-index for the affected bookmarks.diff --git a/release-notes/2024-04-17-v0.12.2.md b/release-notes/2024-04-17-v0.12.2.mdnew file mode 100644index 00000000..d9a348fd--- /dev/null+++ b/release-notes/2024-04-17-v0.12.2.md@@ -0,0 +1,7 @@+Another small hotfix for the [0.12.0](https://github.com/MohamedBassem/hoarder-app/releases/tag/v0.12.0) release.++Fixes:+- Preferred layout was getting lost when the browser is closed and reopened. This is fixed in this release.++Commits:+- fix: Fix user local settings cookie to have max age as by default it's a session cookie. Fix #104 by @MohamedBassem in bb44ebcdiff --git a/release-notes/2024-04-26-v0.13.0.md b/release-notes/2024-04-26-v0.13.0.mdnew file mode 100644index 00000000..0f76dd15--- /dev/null+++ b/release-notes/2024-04-26-v0.13.0.md@@ -0,0 +1,65 @@+Welcome to the `0.13.0` release of Hoarder! This release is packed with a lot of new features to better organize your bookmarks. This includes: Nested lists, tag merging, a new suggested cleanups page, and more! Crawler also now takes screenshots and downloads the banner images locally. The [CLI](https://docs.hoarder.app/command-line) is now more powerful giving you ability to do mass modifications (e.g. archiving/adding to lists) until the mutli-select feature is developed.++> Note: You probably want to read the `Upgrading` section for that release. No breaking changes, but some nice recommendations are mentioned.++## Announcements++- The android app has been finally released on the play store ([link](https://play.google.com/store/apps/details?id=app.hoarder.hoardermobile&hl=en&gl=US))! Thanks a lot to all the beta testers during that time! Go check it out (and maybe give it a review while you're there π). The iOS app is still stuck in apple's review queue unfortunately, so you still need to use the [beta version](https://testflight.apple.com/join/QifpNxAT) for now.+- The new chrome/firefox extensions allow you to quickly add tags and lists to your newly saved bookmarks!++## New Features++- Nested lists are here! When you're creating a new list, you can choose a parent for that list and it'll be nested under it. The `All lists` page has been revamped to support showing the list tree.+- Merging tags is now a thing.+- A new `Cleanups` page that will suggest to you ways to cleanup your collection. As a start, it now detects potentially duplicate tags and suggests merging them. Currently, the algorithm is very simple and will detect duplicates if they have different cases (e.g. `Chess` and `chess`), and also tags that differ by at most one character (e.g. `web-devopment` and `Web development`). The inference job now is also fixed to avoid creating those duplicates in the first place.+ - In the future, tag duplication detection will be able to suggest merging semantically equivalent tags.+- The crawler now by default downloads the banner images. This is to protect against bookmarked links going away, but also to get around rate limits when you have multiple bookmarks from the same website (e.g. github). This will result into a larger storage space utilization. If you don't care about that, you can disable by setting `CRAWLER_DOWNLOAD_BANNER_IMAGE=false`.+- The crawler also will now take screenshots of the website it crawls and allows you to see them in the preview page. The screenshots will also be used as a fallback banner for links that don't have an image. Again, this will use some extra storage, so if you don't want screenshots, you can disable them with `CRAWLER_STORE_SCREENSHOT=false`.+- You can now edit lists to change its name or update its parent.+- You can now see (and manage) all the bookmarks a list is in from the new `Manage Bookmarks` drop down option.+- You can now delete tags from the `All tags` page. The `All tags` page will also show you the "unused" tags and gives you a quick way to mass delete them.+- The CLI got a lot of new commands. You can now update bookmarks from the CLI (e.g. to archive or favourite them), and you can add or remove bookmarks from lists. You can have a look on the updates docs page [here](https://docs.hoarder.app/command-line). Also, you can now get the CLI directly from NPM using `npm install -g @hoarderapp/cli`. The CLI is very useful for now to do mass actions on your bookmark while we develop the multi-select feature https://github.com/MohamedBassem/hoarder-app/issues/84.++## Fixes+- When you preview a bookmark (using the maximize button), the address bar of the browser will now show a unique link for that bookmark.+- The crawler now can correctly find the images in amazon links.+- The search indexing worker was in some rare cases incorrectly reporting success while it actually failed. This is now fixed.++## Screenshots++### The new Cleanups page++<img width="259" alt="Screenshot 2024-04-26 at 2 19 02β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/289efd35-34e2-4d2a-860e-b91774ae46be">++<img width="1071" alt="Screenshot 2024-04-26 at 2 17 28β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/12d035e8-a4ee-4551-849c-26b5705c151a">++### Viewing and mass deleting unused tags++<img width="410" alt="Screenshot 2024-04-26 at 2 18 21β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/08cb6b13-0b42-41af-9739-7571f38cfa67">++### Nested lists++<img width="1051" alt="Screenshot 2024-04-26 at 6 41 00β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/d7bd9897-f1da-4343-87e8-d54c1a17fa41">++<img width="280" alt="Screenshot 2024-04-26 at 5 44 11β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/06e642e2-3a4f-4917-87bd-00bdfb4273e0">++### The new extension capabilities+++### Quick tag deletion++<img width="365" alt="Screenshot 2024-04-26 at 6 40 31β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/b59fd2ce-5d62-4db8-900d-0d29e24df3df">++### Viewing the screenshots++<img width="1212" alt="Screenshot 2024-04-26 at 7 18 11β―PM" src="https://github.com/MohamedBassem/hoarder-app/assets/2418637/4a8b2ec6-22c3-4518-8624-16278331c648">++## Upgrading++- If you're using HOARDER_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.++After Ugprading:+- Now that we're taking screenshots for pages, you'll want to tell chrome to hide scrollbars by adding `--hide-scrollbars` to the `command` section under the chrome container. Check the update docker compose ([here](https://github.com/MohamedBassem/hoarder-app/blob/main/docker/docker-compose.yml)) for reference on how to do it.+- Apparently, meillisearch collects analytics by default unless you opt out. Add `MEILI_NO_ANALYTICS=true` in the environment section of the meillisearch container if you don't want that. Check the update docker compose ([here](https://github.com/MohamedBassem/hoarder-app/blob/main/docker/docker-compose.yml)) for reference on how to do it. Thanks for the report and fix @vivekmiyani!+- The release introduced the ability to download banner images and take screenshots from webpages. Those will be applied only on newly crawled pages. if you want to do the same for your old bookmarks, you can re-crawl all the links from the admin panel by pressing on the `Recrawl All Links (Without Inference)`. Make sure you click the `(Without inference)` button otherwise you'll be re-running automatic tagging which can be expensive.diff --git a/release-notes/2024-04-26-v0.13.1.md b/release-notes/2024-04-26-v0.13.1.mdnew file mode 100644index 00000000..0723c2d2--- /dev/null+++ b/release-notes/2024-04-26-v0.13.1.md@@ -0,0 +1 @@+This is a dummy hotfix release for [0.13.0](https://github.com/MohamedBassem/hoarder-app/releases/tag/v0.13.0) just to fix the missing docker images for `linux/arm64`. No changes in the app itself.diff --git a/release-notes/2024-05-24-v0.14.0.md b/release-notes/2024-05-24-v0.14.0.mdnew file mode 100644index 00000000..205b6f44--- /dev/null+++ b/release-notes/2024-05-24-v0.14.0.md@@ -0,0 +1,56 @@+Welcome to the `0.14.0` release of Hoarder! I want to welcome our two new contributors @kamtschatka who added a bunch of quality of life improvements and @lilacpixel who fixed a bunch of cosmetic issues in Hoarder! I also want to thank @Collectathon who published Hoarder's template on unraid which was a very popular request from unraid users!++> Note: You probably want to read the Upgrading section for that release. No breaking changes, but some recommendations are mentioned.++# Announcements+* Hoarder is now available on the unraid store thanks to @Collectathon! The docs now include an unraid installation section [here](https://docs.hoarder.app/Installation/unraid).+* The iOS app has finally been accepted in the app store ([link](https://apps.apple.com/gb/app/hoarder-app/id6479258022)). Thanks a lot to all the beta testers during that time! You can still continue using TestPilot if you want the latest versions fasters, but you can also now switch to the prod version if you want stability.++# New Features++* Link deduping is here. When adding a link that you've hoarded before, it won't be re-added and instead you'll be prompted to go to your original link. When adding it from the browser extension, the existing bookmark's tags and lists will be shown allowing you to alter them if needed.+ * Note: Unless you're on the latest mobile version, a deduped link will be silently ignored (without any visual indications). Upgrade to the latest version to get a message telling you that it already exists.+* To quickly merge tags, @kamtschatka added support for dragging and dropping tags on each others to merge them together! To aid with the merging, you can now sort the tags in the "All tags" page by name instead of count.+* You can now batch add multiple links to the bookmark editor card (one per line) and hoarder will import them in one go.+* Hoarder can now take full page screenshots (instead of only the top of the page) thanks to @kamtschatka. This is disabled by default as it consumes a lot of space, but can be enabled by setting `CRAWLER_FULL_PAGE_SCREENSHOT=true`.+* In the list management dialog, you can now quickly archive a bookmark after adding it to lists. This is useful to those who follow `Inbox Zero` for their homepage.+* Hoarder is now using openai's new model `gpt-4o` by default for image tagging. It's faster and 50% cheaper!+++# Fixes++* Local tagging with Ollama is now more robust thanks to @kamtschatka refactoring the prompt a bit so that model doesn't lose context on what the instructions actually are.+* Bookmarks that were created in the same second (usually as part of a mass import) were sometimes skipped between pages. This is now fixed.+* A lot of cosmetic touches by @lilacpixel:+ * Clicking on images in the bookmark list now opens the bookmark preview popup.+ * Clicking on an image in the preview popup will open it in full quality in a new browser tab.+ * Long titles used to overflow in modals and in the bookmark grid. This is also fixed by @lilacpixel.+ * The bookmark preview popup's input fields now have full width to better show the available tags.+* The tags in the tags editor are now sorted lexicographically.++# Screenshots++### Link Deduping+<img width="417" alt="Screenshot 2024-05-24 at 12 40 28β―AM" src="https://github.com/hoarder-app/hoarder/assets/2418637/da0c6fa8-de12-4b0c-9ca2-9a6493aa1ddf">++### New Archive Button in "Manage Lists" Dialog+<img width="501" alt="Screenshot 2024-05-24 at 12 41 05β―AM" src="https://github.com/hoarder-app/hoarder/assets/2418637/c728a618-5686-4540-8e55-9d284fc2eebe">++### Multi-URL import+<img width="504" alt="Screenshot 2024-05-24 at 12 41 41β―AM" src="https://github.com/hoarder-app/hoarder/assets/2418637/092bb332-aadf-4e9d-b534-869706ca8513">++### Drag and Drop tag merging++https://github.com/hoarder-app/hoarder/assets/2418637/0e75625c-6295-4ced-b019-cf409f3ad7df+++# Upgrading++* The repo got moved to its own organization, and the docker images unfortunately didn't get moved. which means you might want to update the docker images to the new urls. I'll keep updating the old images for the foreseeable future though. In your docker-compose file, change:+ * `ghcr.io/mohamedbassem/hoarder-web` to `ghcr.io/hoarder-app/hoarder-web`+ * `ghcr.io/mohamedbassem/hoarder-workers` to `ghcr.io/hoarder-app/hoarder-workers`+* To improve chrome's stability for large pages, add `--disable-dev-shm-usage` to the existing list of arguments of the chrome container.++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2024-07-06-v0.15.0.md b/release-notes/2024-07-06-v0.15.0.mdnew file mode 100644index 00000000..c418e9ba--- /dev/null+++ b/release-notes/2024-07-06-v0.15.0.md@@ -0,0 +1,60 @@+Welcome to the `0.15.0` release of Hoarder! It's been a while since the previous release, but this release is packed with a lot of new quality of life improvements and features. This releases wouldn't have been possible without the tons of contributions from @kamtschatka, @mdsaban & @AhmadMuj. I also want to welcome our first time contributors @kou029w & @devome. If you're interested in helping us develop hoarder, you can join our #development channel on [hoarder's discord](https://discord.gg/NrgeYywsFh).+++# New Features++* Bulk actions are now a thing thanks to a contribution from @mdsaban. You can now bulk favourite, archive or delete bookmarks. In the next release, you'll be able to bulk add/remove bookmarks from lists.+* Full page archival is now here (powered by [monolith](https://github.com/Y2Z/monolith)). This will download everything that's in the page so that you can have an offline copy of that page even if that page disappears from the internet afterwards. The archives are typically quite large, so this feature is disabled by default. If you're a true hoarder, you can enable it with `CRAWLER_FULL_PAGE_ARCHIVE=true`.+* When you hoard a URL that points to a pdf or an image, Hoarder will now treat them as pdfs/images instead of links while keeping a reference to their original source. This will also allow automatic tagging to work correctly on those links. (thanks @kamtschatka!)+* You can now import your chrome bookmarks (or any Netscape compatible bookmark file) by exporting them from chrome, then drag and drop the exported file to hoarder. All links in the export will be imported. (thanks @kamtschatka!)+* For those hoarding code snippets, @kamtschatka added syntax highlighting to code blocks and a way to quickly copy the block.+* Hoarder is now available on arch linux's user repo (AUR) and is maintained by @devome. A new wiki page with [installation instructions](https://docs.hoarder.app/Installation/archlinux) is now available.++# UX Improvements++* @mdsaban revamped how both the user and admin settings pages look like.+* In the list layout, the editor will expand as you type longer notes thanks to @AhmadMuj.+* You can now paste images directly in the editor card and they'll get automatically uploaded thanks to @AhmadMuj.++# Fixes++* The layout selector is now more clearly shown above the bookmark grid thanks to @mdsaban.+* Tags that were added manually were not correctly propagating to the search index. This is now fixed by @kamtschatka. You might want to trigger a reindex from the admin page if you've attached some manual tags.+* @kamtschatka fixed a long standing bug that prevented firefox users from using the browser extension without a valid HTTPS certificate.+* The editor card previously allowed you to save empty notes, this has now been fixed by @mdsaban.+* Increased list name max size to 40 chars up from 20.+* We previously had an upper limit on note sizes that we removed a while ago. However, we forgot to remove it when editing a note. @AhmadMuj fixed that.+* The CLI was previously printing invalid JSONs. Now there's a proper JSON mode thanks to @kamtschatka.+* For CJK environments, there's now a sans-serif fallback font thanks to @kou029w.+* Automatically inferred tags could have contained an extra space in the beginning of the tag, @kamtschatka fixed that.+++# Screenshots++## Bulk Editing in Action++https://github.com/hoarder-app/hoarder/assets/45597394/d8625dfe-dcb6-4b1f-91a6-8dbe289cebdb++## Revamped Admin Page++++## Revamped Settings Page++++## Full Page Archives++<img width="1159" alt="Screenshot 2024-07-06 at 11 47 31β―AM" src="https://github.com/hoarder-app/hoarder/assets/2418637/ba0c05d8-5194-4e2a-8c7e-bf02669252f1">++## PDF/Image URL recognition+++https://github.com/hoarder-app/hoarder/assets/2418637/fa9f2323-f0f3-4ce3-9818-e4e65e32fa54+++# Upgrading++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2024-08-31-v0.16.0.md b/release-notes/2024-08-31-v0.16.0.mdnew file mode 100644index 00000000..4a326e19--- /dev/null+++ b/release-notes/2024-08-31-v0.16.0.md@@ -0,0 +1,104 @@+Welcome to the `0.16.0` release of Hoarder. Sorry for the long delay since the last release! We'd like to welcome to our first time contributors @Mxrk, @j-fuentes & @rootly-be!++> NOTE: This release is backward compatible with the previous release, but it's highly recommended that you check out the `Upgrading` section in the release notes.++# New Features+* Deploying Hoarder is now simpler. We're getting rid of two containers in this release:+ * Redis is no longer needed as a dependency and is replaced by a sqlite-backed queue implementation.+ * There's now a new container that acts as both the `web` and `workers` container. You no longer need two different hoarder containers.+ * The old images will continue to work just fine for the foreseeable future to make this release backward compatible. Upgrading to the new image is highly recommended though.+* `gpt-4o-mini` is now the default OpenAI model. This model is 3X cheaper than the previous default!+* The mobile app received a bunch of overdue updates:+ * Added the ability to manage bookmark lists from the app.+ * You can now add/remove lists from the app.+ * You can view full notes by tapping on the notes card and you can now edit them as well+ * You can zoom into uploaded images.+ * You can add/view attached notes to bookmarks.+ * There's now a unified editor for new links and notes. Still pretty basic though.+ * You can now configure the image quality of the uploaded images. Keep in mind that for large images, you might want to increase `MAX_ASSET_SIZE_MB` from the default of `4MB`, otherwise, you'll get an `Asset too big` error.+* Hoarder's notes now support checklists, tables and auto-links in markdown thanks to @kamtschatka+* If you have the browser extension installed, you'll find now a new `Add to Hoarder` button that you can use to send links, texts, images, to hoarder directly. Note: If you're using chrome, you'll need to be on v127 or older. Thanks @kamtschatka!+* @j-fuentes added [kubernetes installation instruction](https://docs.hoarder.app/Installation/kubernetes) to the wiki.++# UX Improvements+* When renaming bookmark titles or tags, pressing Enter will save the changes.++# Fixes+* Importing a lot of URLs from the UI used to error, this no longer the case thanks @kamtschatka.+* SVG weren't correctly loading in full page archives using monolith, @kamtschatka fixed it.+* Bulk deletion confirmation dialog wasn't automatically dismissed after the deletion. This is now fixed by @kamtschatka.+* On the mobile app, login fails if your server URL had an extra slash at the end. @Mxrk fixed that!++# Upgrading++> β οΈ If you have ongoing crawlings/inference/indexing jobs in Hoarder, you'll need to re-enqueue them from the admin panel after the upgrade.++As mentioned in the release notes, this release removes the need for the `redis` container and the worker container. Although the migration is optional given that the old images will work, it's highly recommended, to migrate, you'll need to do the following:+1. Remove the redis container and its volume if it had one.+2. Move the environment variables that you've set exclusively to the `workers` container to the `web` container.+3. Delete the `workers` container.+4. Rename the web container image from `hoarder-app/hoarder-web` to `hoarder-app/hoarder`.++The diff for the compose file will look something like this:++```diff+diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml+index cdfc908..6297563 100644+--- a/docker/docker-compose.yml++++ b/docker/docker-compose.yml+@@ -1,7 +1,7 @@+ version: "3.8"+ services:+ web:+- image: ghcr.io/hoarder-app/hoarder-web:${HOARDER_VERSION:-release}++ image: ghcr.io/hoarder-app/hoarder:${HOARDER_VERSION:-release}+ restart: unless-stopped+ volumes:+ - data:/data+@@ -10,14 +10,10 @@ services:+ env_file:+ - .env+ environment:+- REDIS_HOST: redis+ MEILI_ADDR: http://meilisearch:7700++ BROWSER_WEB_URL: http://chrome:9222++ # OPENAI_API_KEY: ...+ DATA_DIR: /data+- redis:+- image: redis:7.2-alpine+- restart: unless-stopped+- volumes:+- - redis:/data+ chrome:+ image: gcr.io/zenika-hub/alpine-chrome:123+ restart: unless-stopped+@@ -37,24 +33,7 @@ services:+ MEILI_NO_ANALYTICS: "true"+ volumes:+ - meilisearch:/meili_data+- workers:+- image: ghcr.io/hoarder-app/hoarder-workers:${HOARDER_VERSION:-release}+- restart: unless-stopped+- volumes:+- - data:/data+- env_file:+- - .env+- environment:+- REDIS_HOST: redis+- MEILI_ADDR: http://meilisearch:7700+- BROWSER_WEB_URL: http://chrome:9222+- DATA_DIR: /data+- # OPENAI_API_KEY: ...+- depends_on:+- web:+- condition: service_started++ volumes:+- redis:+ meilisearch:+ data:+```++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2024-09-22-v0.17.0.md b/release-notes/2024-09-22-v0.17.0.mdnew file mode 100644index 00000000..06f340ac--- /dev/null+++ b/release-notes/2024-09-22-v0.17.0.md@@ -0,0 +1,70 @@+Welcome to the `0.17.0` release of Hoarder. We have a bunch of new features and UX improvements including SSO support (finally), bulk tag/list actions, better bookmark importing experience, and bunch of other stuff. In this release, we're welcoming @nghduc97 and @Mxrk as first time contributors!++> If you're enjoying Hoarder, you can consider supporting it [here βοΈ](https://buymeacoffee.com/mbassem).++# New Features++* Single Sign On (SSO) support is finally here for OIDC compliant providers. This was the most requested feature and it's now here thanks to @kamtschatka. You can read about how to configure it [here](https://docs.hoarder.app/configuration#authentication--signup).+* We've done multiple improvements to the bookmark importing experience:+ * Bookmark importing now live in the settings page.+ * You can now import bookmarks from a Pocket export.+ * Imported bookmarks will keep their title, tags and creation date.+ * A new list will be created that will include all your newly imported bookmarks. You can remove/rename this list after making sure that everything went according to plan.+* You can now customize the banner image for links and manipulate all its other attachments in the bookmark preview page.+* You can now bulk add/remove tags and lists to bookmarks.+* Some mobile app improvements:+ * In case you were facing issues connecting to hoarder from the app, there's now a "Connection testing" functionality that shows you a more descriptive issue about the problem you're hitting.+ * The app was by default following the theme (e.g. light/dark mode) of the system. You can now configure explicitly the theme that you want in the settings.+ * There's a new floating quick add button to quickly save new bookmarks from within the app.+* For ollama users, you can now configure the timeout of the inference worker in case ollama's responses are slow. You can also configure a model keep alive TTL so that ollama can drop the model from memory if it's not used for that configure period.+* We have a new compact layout to quickly skim through your bookmarks.+++# UX Improvements++* In the tags editor, you can now quickly remove the last tags by pressing backspace.+* The tags editor will now feel much faster by optimistically applying the changes before they are committed on the server.+* On the mobile app, server errors (e.g. connection errors) will have a much better UI indicating the problem and giving you an option to retry.+* Lists are now sorted alphabetically thanks to @kamtschatka.+* Signup dialog now shows a less confusing message when signups are disabled thanks @nghduc97++# Fixes++* Completely deleting a tag was broken, now it's fixed.++# Screenshots++## New Mobile Settings Page++<img width="386" alt="Screenshot 2024-09-22 at 4 58 33β―PM" src="https://github.com/user-attachments/assets/f351c0db-9b7c-48d1-b0ca-76f2c34766fa">+++## Connection Testing+<img width="407" alt="Screenshot 2024-09-22 at 4 52 07β―PM" src="https://github.com/user-attachments/assets/70d46ff9-ded8-497f-8203-489021cb4763">++## SSO Support+<img width="407" alt="Screenshot 2024-09-22 at 4 52 33β―PM" src="https://github.com/user-attachments/assets/8b653987-d923-420a-8b14-2cffd3f7327a">++## Compact Layout++<img width="1401" alt="Screenshot 2024-09-22 at 4 53 46β―PM" src="https://github.com/user-attachments/assets/6cac935c-5ecf-4d65-be92-809811a02104">++## New Import UI++<img width="711" alt="Screenshot 2024-09-22 at 4 57 14β―PM" src="https://github.com/user-attachments/assets/7cd6ceeb-951f-47b4-ab14-0f6827b5f4a9">++## New Bulk Actions++<img width="425" alt="Screenshot 2024-09-22 at 4 55 52β―PM" src="https://github.com/user-attachments/assets/089d6f2e-4c86-4721-9bd1-c16cc21bb473">+++## New Attachments Section++<img width="478" alt="Screenshot 2024-09-22 at 4 55 14β―PM" src="https://github.com/user-attachments/assets/067bf3c9-391d-4a27-80d0-e4f516141481">+++# Upgrading++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2024-09-27-v0.17.1.md b/release-notes/2024-09-27-v0.17.1.mdnew file mode 100644index 00000000..0383b13f--- /dev/null+++ b/release-notes/2024-09-27-v0.17.1.md@@ -0,0 +1,5 @@+This is a small hotfix for the [0.17.0 release](https://github.com/hoarder-app/hoarder/releases/tag/v0.17.0).++## π Fixes+* When importing bookmarks from a netscape html file, there was a bug that would result in the importing bookmarks getting all of your tags. This is fixed in https://github.com/hoarder-app/hoarder/commit/12d3371d12d5709adc6e23b53792cf1dc28a8a06 & https://github.com/hoarder-app/hoarder/commit/4db50c234fb0da8747b902a7c1e551cc54451f4c.+* A "name" is no longer required from SSO providers. @kamtschatka fixed that in https://github.com/hoarder-app/hoarder/commit/e1feeceda475b117dde99a971f87e20a149f7edf.diff --git a/release-notes/2024-10-13-v0.18.0.md b/release-notes/2024-10-13-v0.18.0.mdnew file mode 100644index 00000000..0ac7a86a--- /dev/null+++ b/release-notes/2024-10-13-v0.18.0.md@@ -0,0 +1,78 @@+Welcome to the `0.18.0` release of Hoarder! This release introduces customizable tagging rules (aka customizing the prompt), new UI look, selective full page archives, infinite scrolling, more bulk actions and more! As usual, we'd like to welcome our first time contributors @jarednipper, @Trugamr, @cedmax and @CrypticC3s4r! We also have @Lucius346346 working behind the scene on improving the UX of Hoarder with amazing designs! And finally, we have our usual contributors @kamtschatka and @mdsaban! Also thanks to @Papierkorb for the help in suggestions to improve the LLM prompt!++We also now have a public roadmap which you can check for the features that we're planning to deliver [here](https://github.com/orgs/hoarder-app/projects/1). Go upvote the features that you're waiting for!++> If you're enjoying Hoarder, you can consider supporting it [here βοΈ](https://buymeacoffee.com/mbassem).++# New Feature++* Introducing customizable tagging rules: You can now customize the prompt that we use to generate the tags to your linkings and add custom rules for the LLM to adhere to!+ * You can use this to define your tagging rules in natural language and let the LLM take care of applying it.+* If you don't want to enable "Full page archives" by default, you can now selectively archive particular pages that you want to keep forever thanks to @kamtschatka!+* You can now export your bookmarks from Hoarder and re-import them back in another instance (note: currently images and pdfs are not exported).+* You can now customize the context length of the inference model using the `INFERENCE_CONTEXT_LENGTH` flag:+ * The bigger this value is, the more of your content the model will see and will be able to give you better tagging.+ * However, the bigger the context window, the more expensive the request is for OpenAI money-wise and for ollama resource-wise.+ * The current default is `2048` tokens (~2048 words).+* Better asset tracking and management:+ * We're now currently correctly accounting for all asset sizes in the database. You can view the usage of every user now in the admin panel.+ * Old assets are not automatically accounted for and you'll have to click the new `Compact Asset` button in the admin panel to backfill that data. This button also removes assets that are dangling (aka not linked to any bookmark).+ * This work is in preparation for supporting better privacy checks in the future when we implement public and collaborative lists.+* You can now attach custom image banners to your notes.+ * Those banners will appear at the top of your notes when you expand them as well as in the `List` layout.+ * We're still figuring out a good way to render them in the grid and masonry layouts.++# UX Improvements++* We have a refreshed UI looks thanks to amazing designs by @Lucius346346!+ * We now have a sticky navbar for better experience in bulk editing thanks to @mdsaban.+ * We also have a new profile options dropdown in the header where the user and admin settings buttons got moved to.+* We now have infinite scrolling for pagination so that you no longer need to click the `Show more` button.+* Bulk actions improvements:+ * There's now a `Select all` button to select all the currently visible bookmarks.+ * `Copy links` is also a thing to bulk copy the source links of a bunch of bookmarks thanks to @kamtschatka.+* You can now trigger AI tag regeneration for all bookmarks or the ones that that failed only in the admin panel.+* When you hoard text from other webpages by the extension (by highlighting text -> right click -> add to hoarder) the source link will now be preserved with the text.+* We have a new tabbed user settings page as it was getting quite long.+* Sidebar items were not clickable around the boarder which was annoying. @Trugamr fixed that!++# Fixes+* For those who want to go all-in on Oauth, you can now set `DISABLE_PASSWORD_AUTH=true` which will forbid any password-based authentication/signup. This is implemented by @kamtschatka.+* The All Tags page was taking too long to load when you have too many tags. @kamtschatka landed some improvements to the performance of this page.+* Editing lists from the sidebar was broken, now it's fixed.+* When you wipe your hoarder's database while still logged in the browser, users were getting some confusing behavior with confusing database errors. This is now fixed, and hoarder will automatically log you out if your account is no longer there.+* @Mxrk Added docker healthchecks to the dockerfile and also source label so that hoarder's updates can be correctly reflected in stuff like renovate.+++# Screenshots++## The new UI Look++<img width="1209" alt="Screenshot 2024-10-13 at 3 16 59β―PM" src="https://github.com/user-attachments/assets/0b13bf69-d0a1-4afc-90ca-826f898c3ae1">++## Profile Options++<img width="272" alt="Screenshot 2024-10-13 at 3 49 02β―PM" src="https://github.com/user-attachments/assets/8e5e403c-a52c-4e39-a36a-eebcf96999b8">++## AI Settings and Tagging Rules++<img width="982" alt="Screenshot 2024-10-13 at 3 18 55β―PM" src="https://github.com/user-attachments/assets/d67296d1-26c3-4c55-b346-b0e3d9568d16">++## New Import/Export Buttons++<img width="1345" alt="Screenshot 2024-10-13 at 3 19 46β―PM" src="https://github.com/user-attachments/assets/729bd9c6-18df-4ca3-a70c-7d612b8d1f5a">++## Num Bookmarks & Asset Sizes in Admin Panel++<img width="1327" alt="Screenshot 2024-10-13 at 3 22 13β―PM" src="https://github.com/user-attachments/assets/798fb564-5cb3-4ff8-9230-8262c4642e25">++## New Admin Actions++<img width="669" alt="Screenshot 2024-10-13 at 3 22 21β―PM" src="https://github.com/user-attachments/assets/4e166fdd-f872-4961-beed-779bf2a029cc">+++# Upgrading++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2024-11-09-v0.19.0.md b/release-notes/2024-11-09-v0.19.0.mdnew file mode 100644index 00000000..1581c9a7--- /dev/null+++ b/release-notes/2024-11-09-v0.19.0.md@@ -0,0 +1,58 @@+Welcome to the `0.19.0` release of Hoarder! This release is packed with a lot of new features! The long awaited REST APIs, RSS subscriptions, AI summarization, Image OCR, archiving videos, importing from Omnivore, and more!++> If you're enjoying Hoarder, you can consider supporting it [here βοΈ](https://buymeacoffee.com/mbassem).++# New Feature++* **RSS Subscriptions** π§ͺ: You can now subscribe to RSS feeds and Hoarder will automatically pull them every hour.+ * You can use this to auto hoard stuff from your favourite blogs, subreddits, or youtube channels.+ * This feature is still experimental and haven't been tested on a a wide variety of feeds. Please file issues whenever you face any problems using it.+* The long awaited **REST API** is here. You can view the API docs [here](https://docs.hoarder.app/api).+ * You can view the OpenAPI spec [here](https://github.com/hoarder-app/hoarder/blob/main/packages/open-api/hoarder-openapi-spec.json) in case you want to generate clients for it. I'm planning to offer an official Typescript SDK some time in the future.+* **AI Summarization**: Hoarder now has the ability to generate summaries for the links that you hoard! Check the screenshots section to see it in action.+ * Currently, summarization is a manual action. In the future, we'll add support for auto summarization.+* **Video downloads**: For ultimate hoarding, Hoarder now has the ability to download videos from the links that you hoard (e.g. youtube) thanks to @kamtschatka.+ * Given that videos can be huge, this is an opt-in feature. You can enable it with `CRAWLER_VIDEO_DOWNLOAD=true`. Find more configuration options [here](https://docs.hoarder.app/configuration#crawler-configs).+ * Hoarder uses [ytdl](https://github.com/ytdl-org/youtube-dl) under the hood, and you can find their list of supported files [here](https://ytdl-org.github.io/youtube-dl/supportedsites.html).+* **Omnivore Imports**: Omnivore [is shutting down](https://blog.omnivore.app/p/omnivore-is-joining-elevenlabs). You can now import your bookmarks from Omnivore into Hoarder. Check the documentation [here](https://docs.hoarder.app/import).+* **User Management**: Admins can now reset user passwords, change their roles and even create new users thanks to @kamtschatka.+* **Image OCR**: Hoarder will now attempt to read and index text in the images that you hoard! Check the configuration variables [here](https://docs.hoarder.app/configuration#ocr-configs).+* Others:+ * @kamtschatka Added authentication failure logging in case you want to configure fail2ban against hoarder logs.+++# UX Improvements++* We have a new redesigned settings page to better support the new options we're adding. Check it out in the screenshot section.+* You can use `Cmd/Ctrl + K` to quickly focus on Hoarder's searchbar.+* We reverted the mobile apps to again view webpages inline, but now added buttons for quick actions underneath it.++# Fixes++* Single new lines in notes were getting lost in markdown. @kamtschatka fixed that.+* Pocket switched their export format to CSVs instead of their old format. Hoarder now supports importing the new format.+* Tags that had numbers or dashes in them were getting skipped, this is now fixed. Thanks @MakeSomeGood for the bug report and investigation!+* The `All Tags` page was getting very slow when there's a lot of tags. This turned out to be a small misconfiguration in the database that we fixed.+* Custom prompts had a max length of 100, which wasn't enough to some people. The new limit is 500.+++# Screenshots++## AI Summarization++https://github.com/user-attachments/assets/062bcfcc-139c-421d-8caf-0941998f8575++## RSS Feeds & New Settings Page++<img width="1482" alt="Screenshot 2024-11-09 at 4 11 59β―PM" src="https://github.com/user-attachments/assets/1908577c-2b8c-4a60-8a45-0d7b239ac0a5">++## Admin User Management++<img width="973" alt="Screenshot 2024-11-09 at 4 15 47β―PM" src="https://github.com/user-attachments/assets/180e030c-0dbb-45c0-8241-c3f614513393">+++# Upgrading++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2024-12-22-v0.20.0.md b/release-notes/2024-12-22-v0.20.0.mdnew file mode 100644index 00000000..9065fc68--- /dev/null+++ b/release-notes/2024-12-22-v0.20.0.md@@ -0,0 +1,98 @@+Welcome to the `0.20.0` release of Hoarder! This release adds internationalization support, new markdown editor, mobile app improvements, broken link management and more! As usual, we're welcoming our new contributors: @Tukks, @vhsdream, @sweepies, @PeterDaveHello, @wuast94 and @eltociear!++> If you're enjoying Hoarder, you can consider supporting it [here βοΈ](https://buymeacoffee.com/mbassem) or via github [here](https://github.com/sponsors/MohamedBassem).++# New Features++* **Hoarder's UI now comes in multiple languages**!+ * You can change the language of the UI now to English, German, French, Swedish, Simplified and Traditional Chinese.+ * If you want to see your language there or want to improve some existing translation, you can do that via weblate [here](https://hosted.weblate.org/engage/hoarder/).+* **New experimental WYSIWYG markdown editor** for notes by @Tukks!+ * You'll now get a preview of the notes you're writing as you're writing them!+* **A bunch of mobile app improvements**:+ * You can now manage tags from the app. Super overdue, I know.+ * We have a new cleaner "info" page with the ability to edit title/tags/lists all in one page.+ * The mobile app now looks *slightly* more native. We've got rid of the dedicated search tag, switched to native modals, and used native page headers when possible.+ * Note: The apps are yet to be approved by apple & google.+* **Broken Link management**:+ * Hoarder now stores the status codes it got when crawling websites which will allow you to identify and decide what to do about broken links.+ * This is now mainly useful for people doing large imports into hoarder, but in the future, we'll use the same mechanism to support automatic link liveness healthchecks.+* **Chrome as an optional dependency (aka minimal installation)**:+ * Chrome is no longer a hard dependency. This is useful for people running hoarder in resource constrained environments.+ * If you don't specify a `BROWSER_WEB_URL`, hoarder will fallback to a plain HTTP requests to the websites you add instead of crawling them with chrome.+ * Without chrome, you'll lose the ability to get screenshots from the websites you crawl, and websites that heavily rely on javascript won't work properly.+ * With chrome and meilisearch being optional dependencies, you can now get a single-container minimal installation of hoarder by sacrificing some of the features.+* **New installation methods**:+ * Debian / Ubuntu one click installation script ([docs](https://docs.hoarder.app/next/Installation/debuntu)) by @vhsdream+ * If you're a proxmox user, you can also get a one click LXC container running hoarder using [proxmox's helper scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=hoarder) again thanks to @vhsdream.+ * PikaPod ([docs](https://docs.hoarder.app/next/Installation/pikapods)) are now offering paid hoarder hosting (~$3/month) for the less tech savvy folks out there. Disclaimer: they're sharing some of their revenue from Hoarder with us.+* **Tags placeholder in AI prompt customization:**+ * You can use the placeholders `$tags`, `$aiTags`, `$userTags` in the prompt. These placeholders will be replaced with all tags, ai generated tags or human created tags when automatic tagging is performed thanks to @kamtschatka.+ * With that, you can use this to instruct the LLM to only use existing tags (instead of coming up with new ones). Be careful though if you have a lot of tags as it might increase the cost of the tagging significantly.+ * This mechanism is just a temporary solution. We're working on a mechanism to support this natively, in a much cheaper way.+* **New community projects documentation page** ([here](https://docs.hoarder.app/next/community-projects)):+ * With the release of the REST API in the last version, we started seeing some community projects pop up. So we're starting a new documentation page to list them out for visibility.+ * Hoarder now has a **[raycast extension](https://www.raycast.com/luolei/hoarder)** and an **[alfred workflow](https://www.alfredforum.com/topic/22528-hoarder-workflow-for-self-hosted-bookmark-management/)** thanks to @foru17 and @yinan-c. Go install them now!+ * If you develop a new extension for hoarder, let us know as we'd love to feature it in that page!+* Others:+ * We've added the ability to show admin warnings in the admin panels for misconfigurations or future migrations.++# UX Improvements++* We're now trimming email addresses out of whitespaces during signin thanks to @sweepies!++# Fixes+* AI summarization sometimes included the LLM's response to the prompt (e.g. "Ok, I'll summarize ..."). We're now instructing the model to only respond with the summary.+* Fix broken homepage when hitting a bookmark with an invalid image URL.+* Multiple worker reliability improvements specially in countries with restricted internet.+ * The worker container doesn't need to download pnpm on startup anymore as it's now bundled in the container.+ * The crawler's adblock list download now has a timeout and can be completely bypassed with `CRAWLER_ENABLE_ADBLOCKER=false`.+ * The worker was sometimes hanging in the screenshot call. This now has a timeout as well.+++# Screenshots++## The new Markdown Editor++<img width="710" alt="Screenshot 2024-12-22 at 12 59 10β―PM" src="https://github.com/user-attachments/assets/9eadef85-679c-4c21-b2f6-432f75d7056d" />++## Broken Link Management++<img width="978" alt="Screenshot 2024-12-22 at 1 04 43β―PM" src="https://github.com/user-attachments/assets/3cadceb4-deb3-4588-af7a-5b2617ba5266" />++## Mobile App Improvements++New options at the bottom of the bookmark preview page++<img src="https://github.com/user-attachments/assets/a192f806-0431-4390-afc9-641bbfb90967" width="300px" alt="3EA11BCA-C06A-4681-AC44-D87DB9BC8954">++Tag Management+<img src="https://github.com/user-attachments/assets/a6cdf234-ff11-4e91-ba85-8850f2cd12a8" width="300px" alt="9A4562B4-9429-41CA-AFCC-0A45941D3ACF">++The new info page+<img src="https://github.com/user-attachments/assets/56b52981-e556-49fa-9db5-b3445984cd76" width="300px" alt="E679CFD4-7EEB-4910-8FD6-B1EC92090D81">++## Admin Notices++<img width="251" alt="Screenshot 2024-12-22 at 12 57 10β―PM" src="https://github.com/user-attachments/assets/943ae106-8eec-4f29-a145-766531ef9d19" />+<img width="979" alt="Screenshot 2024-12-22 at 12 57 20β―PM" src="https://github.com/user-attachments/assets/a73f734c-9501-4d7c-b01b-02d5df1c7cdb" />++## Raycast extension and Alfred workflows++> *Those screenshots are from the authors of the extensions.*++[Raycast extension](https://www.raycast.com/luolei/hoarder) by @foru17++++[Alfred workflow](https://www.alfredforum.com/topic/22528-hoarder-workflow-for-self-hosted-bookmark-management/) by @yinan-c++++++# Upgrading++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2025-01-05-v0.21.0.md b/release-notes/2025-01-05-v0.21.0.mdnew file mode 100644index 00000000..84963c51--- /dev/null+++ b/release-notes/2025-01-05-v0.21.0.md@@ -0,0 +1,77 @@+# 0.21.0 - The 10k β release!++Welcome to the `0.21.0` release of Hoarder! Hoarder just hit 10k stars on github and I can't be more grateful! We wouldn't have hit this milestone without all of our contributors, users and the awesome community at `/r/selfhosted`! Over the holidays, Hoarder [got featured](https://news.ycombinator.com/item?id=42485746) at the homepage of hackernews for an entire day!++We're celebrating this milestone, with a release that contains some of the long awaited features! This release introduces advanced search capabilities, smart lists, highlighting support, a TypeScript SDK, and more! As usual, we're excited to welcome our new contributors: @lexafaxine, @jdhartley, @medo & @circuitcreature!++> If you enjoy using Hoarder, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).+++# New Features π++- **Advanced Search Capabilities**: Hoarder's search just got much more powerful. You can now add search "qualifiers" to refine your search results. Qualifiers include: tags, lists, favourite/archived status, creation date, etc. You can read about the new query language [here](https://docs.hoarder.app/next/Guides/search-query-language). Some examples:+ - `is:fav after:2024-01-01 before:2024-12-31`: Find all the bookmarks that are favourited and created in 2024.+ - `(#neovim or #vscode) and -is:archived`: Find all the non-archived bookmarks that are tagged either with #neovim or #vscode.+ - `is:archived -is:inlist`: Find all the bookmarks that are archived but are not sorted in any list.+ - `url:github.com neovim`: Find all the bookmarks that were hoarded from github and contains the `neovim` term in its content.+ - Special shoutout to @kamtschatka who first advocated for the powerful search language and did the first implementation.+- **Smart Lists**: With the new powerful search, hoarder now allows you to save your searches as what we're calling "smart lists". Smart lists saves you the hassle of manually managing lists, and allows you create an automatic lists that dynamically matches a specific search query. For example:+ - Instead of manually managing a list called `3d Printing`, you can now create a smart list with the query `url:makerworld.com or url:printables.com or #3dprinting`. Which will include everything you hoarded from popular 3d printing websites and everything the AI/you tagged with the `3d printing` tag.+ - A smart list with the query `url:reddit.com/r/selfhosted and is:fav` will include all the stuff that you hoarded from the `r/selfhosted` subreddit and favourited.+- **Highlighting Support**: You can now highlight your favourite quotes from the links that you hoard, and have a way to view all what you've highlighted. This was one of the most requested features specially for those coming to Hoarder from Omnivore.+- **Linkwarden Import**: You can now import your bookmarks from Linkwarden thanks to @circuitcreature).+- **More translations**: Croatian, Danish, Dutch, Galician, Italian, Japanese, Polish, Russian, Spanish & Turkish. Thanks to all those who contributed those translations over weblate (@Jaksa101, @bcanata, @KilFer, @mathyvds and more on weblate).++# UX Improvements β¨++- The admin page now features a sidebar layout, for a more consistent experience with the settings page.+- Bookmarks created over a year ago now show the creation year in the card footer (@jdhartley).+- Added a confirmation dialog before deleting bookmarks to prevent accidental deletions (by @lexafaxine).+- Previously, search used to show only at most 20 bookmarks. This now fixed, and you can scroll across search results.++# For Developers π οΈ++- We're now publishing a [minimal typescript sdk](https://www.npmjs.com/package/@hoarderapp/sdk) on npm. This allows you to quickly call hoarder's API endpoints with strong typing in both the requests and responses.+- The search endpoint is now exposed in the REST API as `GET /bookmarks/search` with the support for advanced search queries.+- You can now manipulate the assets attached to a bookmark with the new `/bookmarks/assets/...` endpoints.+- The new highlights feature is also available via the API in `/bookmarks/highlights/...` endpoints.+++# Fixes π++- Fix missing scrollbar in the preview model for long notes.+- Refactored asset serving to not load the entire asset in memory. This should result in lower memory consumption when serving large assets (e.g. videos and full page archives).+- Added support for self signed certs for android by @CrypticC3s4r (pending mobile app release).+- Previously the iOS app didn't allow connecting to hoarder over http, this limitation should no longer by there (pending mobile app release). *Though honestly, you probably shouldn't be serving hoarder over http*.+- Mobile devices without cameras (e.g. eink tablets) were not able to install the app. This is now fixed (pending a mobile app release).++# Community Projects π‘++*Checkout our community projects page [here](https://docs.hoarder.app/community-projects).*++- @Madh93 Implemented [a new telegram bot](https://github.com/Madh93/hoarderbot) that allows you save stuff to hoarder by sending it to the bot on telegram!++# Screenshots πΈ++## Highlights Support+<img width="646" alt="Screenshot 2025-01-05 at 4 29 59β―PM" src="https://github.com/user-attachments/assets/56b3bb2f-704f-4109-ae29-fa55cf716728" />++<img width="321" alt="Screenshot 2025-01-05 at 4 30 08β―PM" src="https://github.com/user-attachments/assets/458bec61-2a2c-4321-b586-094709b63abf" />++<img width="978" alt="Screenshot 2025-01-05 at 4 30 23β―PM" src="https://github.com/user-attachments/assets/dcd2c1e9-0743-4719-a435-1668623e19f0" />++## Smart Lists++<img width="499" alt="Screenshot 2025-01-05 at 4 32 16β―PM" src="https://github.com/user-attachments/assets/420c9243-66ce-435f-adf7-30e84f47dc9e" />+++## The new Admin Page++<img width="1215" alt="Screenshot 2025-01-05 at 4 33 30β―PM" src="https://github.com/user-attachments/assets/9fd5da45-1ae3-4307-9a81-2b9576253720" />+++# Upgrading π¦++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2025-02-02-v0.22.0.md b/release-notes/2025-02-02-v0.22.0.mdnew file mode 100644index 00000000..eccf95df--- /dev/null+++ b/release-notes/2025-02-02-v0.22.0.md@@ -0,0 +1,74 @@+# 0.22.0++Welcome to the `0.22.0` release of Hoarder! This is a lightweight release given the recent events. This release introduces Webhook support, SingleFile support, bookmark sorting, and a lot of fixes! As usual, welcoming our new contributors @hanguofeng, @dakshpareek, @danielvigaru, @techtrd & @meysam81 (and a lot more translators on weblate)!++> If you enjoy using Hoarder, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++# New Features π++* **Webhook support** (by @hanguofeng): Hoarder can now be configured to send webhooks whenever a new bookmark is created/edited. You can use that to trigger further automation/actions in external apps.+* **SingleFile Support**: Hoarder now supports being a destination for the [SingleFile](https://chromewebstore.google.com/detail/singlefile/mpiodijhokgodhhofbcjdecpffjipkle?hl=en) extension. This allows you to store content from websites that requires authentication for example which wasn't possible before. Read more about how to configure it [here](https://docs.hoarder.app/next/Guides/singlefile).+ * This is an experimental feature and is meant to be a stopgap until native support for it in the extension is added.+ * Currently, screenshotting for websites archived this way is not supported. We're planning to add it in a future release.+* **Summarization Prompt Customization**: Similar to the tagging prompts, you can now customize the summarization prompt with your own custom rules in the "AI Settings" page.+* **Bookmark Sorting** (by @dakshpareek): You can now sort your bookmark grid by newest/oldest.++# UX Improvements β¨++* You can now search by bookmark types with the new search qualifiers `is:link`, `is:text` or `is:media`.+* Smart list dialog now contains a link to the query language documentation and also shows the parsed query as you write it.+* @danielvigaru fixed the margins of the lists page in the mobile app.++# For Developers π οΈ++* Hoarder now tracks bookmark modification times and exposes it in the`modifiedAt` field in the bookmark schema. This can be useful that uses the API for syncing changes.+* @techtrd landed a bunch of improvements to the kubernetes documentation and templates! Check it out at [this link](https://docs.hoarder.app/next/Installation/kubernetes).++# Fixes π++* Mobile image uploads has been broken for a while (I'm sorry!). This is now fixed and pending google/apple's review for the release (it's a client side bug).+* Installing hoarder on ubuntu/LXC containers got broken last week due to one un pinned linter dependency. This is now fixed.+* Background job timeouts sometimes used to result into duplicate full page archives (which eats a ton of storage). This should be now fixed.+* Mobile app sign in page used to sometimes flicker rapidly if you enter it with the keyboard open (_I hate mobile app development!_). This is now fixed.+* Search queries for tags/lists that starts with "and"/"or" (such as #android) where not getting correctly parsed. This is now fixed.+* The highlight feature from last release was making it hard to copy content from articles you saved. This is now fixed.+* You no longer need to set `NEXTAUTH_URL_INTERNAL` as it's now baked into the docker image.+* Doing a bulk action with 150+ bookmarks selected no longer fails.+* The `url` qualifier in search now also matches the source URLs of assets (e.g. when you clip a quote from a website using the extension).+* RSS fetcher now uses firefox's user agent thanks to @meysam81.+* Tags that was attached at least once by humans will no longer show up in the "AI tags" section in the "All Tags" page.+* Default max upload size has been increased to 50MB instead of 4MB.+* Spanish translation wasn't working, this is fixed now. We've also added Hungarian translation.++# Community Projects π‘++*Checkout our community projects page [here](https://docs.hoarder.app/community-projects). We're featuring two community projects in this release:*++### Obsidian Sync Plugin++By @jhofker++An Obsidian plugin that syncs your Hoarder bookmarks with Obsidian, creating markdown notes for each bookmark in a designated folder. Get it [here](https://github.com/jhofker/obsidian-hoarder/), or install it directly from Obsidian's community plugin store ([link](https://obsidian.md/plugins?id=hoarder-sync)).++### Hoarder's Pipette++By @DanSnow++A chrome extension that injects hoarder's bookmarks into your search results (inspired by [linkding-injector](https://github.com/fivefold/linkding-injector)). Get it [here](https://dansnow.github.io/hoarder-pipette/guides/installation/).++# Screenshots πΈ++### Webhook Settings+<img width="982" alt="Screenshot 2025-02-02 at 5 03 26β―PM" src="https://github.com/user-attachments/assets/19063d9c-23a8-4536-8db9-f4290542b19b" />++### Bookmark Sorting+<img width="215" alt="Screenshot 2025-02-02 at 5 04 02β―PM" src="https://github.com/user-attachments/assets/7cbde5ca-d711-488b-b60c-d717141566e9" />++### Query Explanation in List Dialogs+<img width="597" alt="Screenshot 2025-02-02 at 5 16 23β―PM" src="https://github.com/user-attachments/assets/8ab290de-6468-4c8a-bfa7-3a048c9968c8" />++# Upgrading π¦++To upgrade:+* If you're using HOARDER_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`.diff --git a/release-notes/2025-03-22-v0.23.0.md b/release-notes/2025-03-22-v0.23.0.mdnew file mode 100644index 00000000..5edd859f--- /dev/null+++ b/release-notes/2025-03-22-v0.23.0.md@@ -0,0 +1,73 @@+# 0.23.0++Welcome to the `0.23.0` release of Hoarder! This release brings quality of life improvements, bug fixes, and introduces several new features, including the long awaited safari extension, PDF screenshotting, bulk tag deletion, and an assets management page! We welcome new contributor @Kaio-Cesar, @erik-nilcoast, @mos3abof, @halkeye, @saadmanfarhad, and @lexafaxine (and as usual, many more translators on Weblate!).++> If you enjoy using Hoarder, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++# New Features π++* **Safari Extension**: The long awaited safari extension is now finally in [TestFlight](https://testflight.apple.com/join/KTQdj2PW).+* **PDF Screenshot Generation and Display** (by @AhmadMuj): Hoarder can now generate screenshots for PDF files and display them, making it easier to preview and identify saved PDFs.+* **Bulk Tag Deletion** (by @lexafaxine): You can now delete multiple tags at once, simplifying tag management.+* **Asset Management Page:** A new settings page allows you to manage your assets and find the ones eating most of your storage.+* **"AI Tagged" Webhook Trigger:** You can now configure webhooks to trigger when AI automatically tags a bookmark.+* **YTDLP Command Line Arguments:** youtube-dl library supports a ton of configuration and flags. This release allows you to configure the flags that gets passed to the YTDLP binary for better control on video downloads. (by @erik-nilcoast)++# UX Improvements β¨++* Import/Export Page got redesigned to look slightly nicer.+* The web UI now displays statistics for your lists directly in the sidebar.+* Merged background jobs stats and admin actions in the admin panel. Also the stats show more workers that were previously missing.+* Multiple new languages got enabled (Arabic, Slovak, Portuguese (Brazil), Slovenian & Vietnamese). Some of those languages are AI translated, please help us enhance them over at [weblate](https://hosted.weblate.org/engage/hoarder/).++# For Developers π οΈ++* Bookmark Summarization: The API now exposes a way to trigger bookmark summarization. (by @erik-nilcoast)+* User Stats Endpoints: Added new endpoints to retrieve user information and statistics. This is used by the new homepage widget support implemented by @vhsdream.+* We now have a new [CONTRIBUTING.md](https://github.com/hoarder-app/hoarder/blob/main/CONTRIBUTING.md).+* Added instructions for setting up the Node.js environment for development (by @mos3abof)++# Fixes π++* Fixed an issue that was preventing the use of LLM providers like gemini and preplexity. If you're running ollama, you might need to upgrade your server to a newer version. If the model you're using doesn't support structured outputs, set `INFERENCE_SUPPORTS_STRUCTURED_OUTPUT=false`.+* Fixed an issue where shared links on mobile were incorrectly stored as text (undergoing apple's review).+* Fixed webhook events being sent regardless of user-selected operations.+* Fixed an issue were RSS feed ingestion was failing for some feeds.+* You can now access the lists from the PWA, which was missing before.+* Hardened the `getBookmarks` endpoint against inconsistent bookmarks.+* Fixed an issue in mobile to correctly set a dark theme classname to update the header text color. (by @saadmanfarhad).+* Fixed corepack issues in the CI and docker build, and in the Linux installation script.+* Added a custom fetch wrapper for Ollama inference that prevents timeouts for slow ollama instances (by @halkeye)+* Added an environment variable to configure OAuth timeouts. (by @Kaio-Cesar)++# Community Projects π‘++## Hoarder Random Bookmark++By @treyg++Sends random bookmarks from your Hoarder account to your email, Discord or exposes your hoarder bookmarks over RSS. Get it [here](https://github.com/treyg/hoarder-random-bookmark).++## Homepage Widget++By @vhsdream++Homepage now has a Hoarder widget that exposes stats about your bookmarks. Get it [here](https://gethomepage.dev/widgets/services/hoarder/).++# Screenshots πΈ++## The new Asset Management Page++<img width="987" alt="Screenshot 2025-03-22 at 5 08 12β―PM" src="https://github.com/user-attachments/assets/31dbe796-7394-4b34-8958-4098dc25a6d1" />++## The redesigned Import/Export page++<img width="971" alt="Screenshot 2025-03-22 at 5 08 26β―PM" src="https://github.com/user-attachments/assets/933f3cb0-b780-47ce-b859-4cca92ef0ee6" />+++# Upgrading π¦++To upgrade:++* If you're using `HOARDER_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`.diff --git a/release-notes/2025-04-05-v0.23.1.md b/release-notes/2025-04-05-v0.23.1.mdnew file mode 100644index 00000000..904b2076--- /dev/null+++ b/release-notes/2025-04-05-v0.23.1.md@@ -0,0 +1,39 @@+# 0.23.1 (Hoarder is rebranding to Karakeep)+++This is not a typical release. Hoarder is rebranding to Karakeep. For context about the rebranding, check out the reddit announcement [here](https://www.reddit.com/r/selfhosted/comments/1js667o/hoarder_is_rebranding_to_karakeep/).++The name Karakeep is inspired by the Arabic word "ΩΨ±Ψ§ΩΩΨ¨" (karakeeb), a colloquial term commonly used to refer to miscellaneous clutter, odds and ends, or items that may seem disorganized but often hold personal value or hidden usefulness. It evokes the image of a messy drawer or forgotten box, full of stuff you can't quite throw awayβbecause somehow, it matters (or more likely, because you're a hoarder!).++However, we also have a couple of new contributors to this minor version. Welcome @ekambains, @Summon528, @jaworek, @jferch, @denysdovhan to the contributors list!+++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++# New Features π++* Well, we're rebranding!+ * This release shows a banner in the admin panel about the rebranding. It's still unclear whether I'll be able to continue updating the hoarder docker image after the repo name change, so I wanted what might potentially be the last stable release on this image to inform the people about the change in the image name. If it turns out that I can continue updating the image, I'll drop the banner.+ * Please note that the new docker image will not yet be available until I execute the repo transfer.+* You can now store the assets in a separate directory by setting the `ASSETS_DIR` env variable. This allows people to offload the assets that can potentially grow larger into a network-mounted directory for example.+* Hoarder now stores and indexes the author and publisher attributes of links. In a future release, we'll start showing them in the UI. (by @erik-nilcoast).+++# UX Improvements β¨++* Clicking view original now opens in a blank tab (by @ekambains).+* Link to Github release page in web sidebar (by @aworek).+* Drop the font weight from sidebar items which makes the sidebar slightly nicer.++# Fixes π++* Fixes issue where hoarder was running out of memory when uploading a large archive with SingleFile.+* Added a configurable crawler screenshot time `CRAWLER_SCREENSHOT_TIMEOUT_SEC` (by @Summon528)+++# Upgrading π¦++To upgrade:++* If you're using `HOARDER_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`.diff --git a/release-notes/2025-04-06-v0.23.2.md b/release-notes/2025-04-06-v0.23.2.mdnew file mode 100644index 00000000..c962428e--- /dev/null+++ b/release-notes/2025-04-06-v0.23.2.md@@ -0,0 +1 @@+This is a dummy release to retrigger the generation of the ARM builds. Refer to the releases notes of [0.23.1](https://github.com/karakeep-app/karakeep/releases/tag/v0.23.1) instead.diff --git a/release-notes/2025-04-27-v0.24.0.md b/release-notes/2025-04-27-v0.24.0.mdnew file mode 100644index 00000000..546a274f--- /dev/null+++ b/release-notes/2025-04-27-v0.24.0.md@@ -0,0 +1,118 @@+# 0.24.0 β Riding the MCP hype++Welcome to the 0.24.0 release of Karakeep! This release packs a ton of new stuff (we're back to shipping folks!). This release introduces a new MCP server for interacting with Karakeep through LLMs, a new rule generic rule engine for more control over organizing your bookmarks, new search qualifiers for feeds and bookmark age, overdue edit dialog for bookmark details, some UI polishing and more! This release also welcomes a TON of new contributors, @brandonw3612, @yorch, @Summon528, @dotvhs, @YTKme, @hasansino, @gomnitrix, @adripo, @meysam81, @SteffoSpieler, @jkywalker (And I probably missed some).++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++## New Features π++### β¨ MCP Server β¨++Unless you've been living under a rock recently, you've heard about the recent explosion of MCP servers all over the internet.+We're not going to miss the hype. This release ships a new MCP server ([docs](https://docs.karakeep.app/mcp)) that allows you to interact with your Karakeep instance and bookmarks through extrenal LLMs.+You can ask the LLM to summarize your bookmarks, search the web and send what it finds to Karakeep, or archive your recent chat as a text note in karakeep.+It can create new lists, attach tags and more to help you organize your bookmarks.+++++More demos in the screenshot section.++### Generic Rule Engine βοΈ++Karakeep was born because I don't want to spend time organizing what I hoard. I just throw stuff in there and karakeep's tagging and search will help me retrieve it later.+However, turns out that not everyone is in the same camp. If you're one of those people who enjoy organizing their bookmarks, this feature is for you.+This release introduces a new generic rule engine that allows you to define arbitrary processing rules for organizing your bookmarks.++Some examples:+1. If a bookmark is added, and it's coming from youtube, tag it with "#youtube" and "#video".+2. If a bookmark is favourited, download an offline archive for it.+3. If the tag "#fashion" is added to a bookmark, and this bookmark is an image, then add it my "Inspiration" list (You're better off using a smart list for this though).+++++### β οΈ The firefox extension is back under a new name (Action Required) β οΈ++After the rebranding unfortunatly we couldn't get the old Firefox extension back, so we had to publish a new one ([link](https://addons.mozilla.org/en-US/firefox/addon/karakeep/)).+If you're using the old "firefox" extension, you MUST migrate to the new one manually otherwise you won't be getting future updates.+++### And more!++* **gpt-4.1-mini is the new default text model**: The default OpenAI text model changed to the new 4.1-mini. It's slightly more expensive than 4o-mini, but is supposed to be much smarter. The image model remains as 4o-mini as 4.1-mini is more expensive for images.+* **New Search & Smart list Qualifiers**:+ * New βage:β search qualifier to show bookmarks older or newer than a given duration (by @brandonw3612).+ * New "feed:" search qualifier to find bookmarks imported from certain RSS feeds.+ * You can find the full query language [here](https://docs.karakeep.app/Guides/search-query-language).+* **Edit Bookmark Details**: You can now edit almost all the details of bookmarks. The URL, summary, creation date, everything. This is obviously very overdue.+* **List Merging**: You can now merge lists together thanks to @gomnitrix.+* **Import Tab Session Manager Sessions**: Bulk-import your Chrome/Firefox Tab Session Manager session files as Karakeep bookmarks by @yorch.+* **Configuring other AI providers**: We added documentations for how to configure other AI providers beside OpenAI ([link](https://docs.karakeep.app/next/Guides/different-ai-providers)). This includes providers like Google AI Studio, OpenRouter, Perplexity, etc.+* **Karakeep on TrueNAS**: People using TrueNAS can now find Karakeep in TrueNAS' app store thanks to @stavros-k.++## UX Improvements β¨++* Some UI polish+ β Reduced shadows, lighter font weights, smaller editor box following the suggestions of @dotvhs in #1261!+ β Removed focus rings where they don't matter much, fix popovers to the emoji picker (by @Mxrk), and list items in the sidebar now get truncated if they're long.+ β Fixed margins of the βNew Listβ button, and fixed spinner visibility during AI summarization+* Cached content is now called βReader Modeβ content.+* There's now a nice looking "No bookmarks" banner for search and empty smart lists.+* Lists now can have a short description beside their name (by @ekambains).+* A new monochrome icon for android builds by @SteffoSpieler.+* Copy link button now gets greyed out when on a non-secure context by @ekambains.+* The github link in the sidebar now works correctly for people on the nightly build thanks to @hasansino.++## For Developers π οΈ++* Added `includeContent` to the API endpoints that return bookmarks (Listing, search, etc) to control whether the endpoint should include the content of the bookmark (which can be huge or not).+ * β οΈ For backward compatibility, this defaults to `true`, but starting from the next release, this will default to `false`. So if your tool relies on the content of the bookmarks, start passing this to `true` now.+* The API docs have a new look. The new look also fixes the enum-like requests types (like the one in createBookmark).++## Fixes π++* **Smart lists in search**: Smart lists are now correctly resolved in the search qualifiers `list:` and `is:inlist`.+* **A much faster homepage loading times**: If you've been a user for the SingleFile extension, Karakeep's homepage might have started getting slower recently. The UI was accidently downloading a big chunk of the archive in the homepage when it's not needed. This is now fixed.+* **Faster Imports**: Importing bookmarks used to be extremely slow, now it's done with much higher parallelism and should be significantly faster.+* Dark-mode icons for the firefox extension @L-K-M+* Fixed the list getting opened when editing it from the sidebar.+* Added a new `INFERENCE_OUTPUT_SCHEMA` configuration to restore support for models that only works with JSON mode (instead of the newer structured output mode).+* Passwords stored in the database are now [salted](https://en.wikipedia.org/wiki/Salt_(cryptography)). For backward compatibility, existing users will continue using an empty salt until they change their password.+* Karakeep now closes the browser after it's done crawling in "on demand" mode by @Summon528.+* Fixed a bug in content extraction that might result in a suboptimal "cached content" being shown.+* Triggering a search re-index now drops all the documents first to avoid dangling documents.++## Community Projects π‘++### Github 2 Karakeep Importer++*By @hasansino*++Exports your github stars automatically to Karakeep! Get it [here](https://github.com/hasansino/github2karakeep).++## Screenshots πΈ++### MCP Demo++++++### The new "No Bookmarks banner"++++### Bookmark Editing Dialog++++## Upgrading π¦++If youβre using `KARAKEEP_VERSION=release`:++`docker compose pull && docker compose up -d`++If you pin to a specific version, update `KARAKEEP_VERSION`, then:++`docker compose pull && docker compose up -d`diff --git a/release-notes/2025-04-28-v0.24.1.md b/release-notes/2025-04-28-v0.24.1.mdnew file mode 100644index 00000000..0a110544--- /dev/null+++ b/release-notes/2025-04-28-v0.24.1.md@@ -0,0 +1,5 @@+This is a hotfix release for [0.24.0](https://github.com/karakeep-app/karakeep/releases/tag/v0.24.0).++## π Fixes+- Reverts the smart list expansion in `list:` and `is:inlist` qualifiers as it can cause Karakeep's server to OOM (#1321).+- Adds missing translations for the new features released in `0.24.0`.diff --git a/release-notes/2025-06-08-v0.25.0.md b/release-notes/2025-06-08-v0.25.0.mdnew file mode 100644index 00000000..078d7d40--- /dev/null+++ b/release-notes/2025-06-08-v0.25.0.md@@ -0,0 +1,75 @@+# 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 βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++# New Features π+- **Public Lists are here:** You can now share your curated lists publicly! (#1511). Example list [here](https://try.karakeep.app/public/lists/f9ot2k3ogai51gvm3v6k0aoq).+- **RSS Feed Generation:** Create and share RSS feeds directly for your lists (#1507)+- **Overdue Mobile Improvements**:+ - Added reader mode/screenshot/archive views to bookmark previews on mobile (pending app release) (#1509) - @digithree+ - View PDFs directly in the mobile app and share them to karakeep from the share sheet as well (#1519, #1494) - @codelove77+- **Import / Export improvements**:+ - Added NETSCAPE file 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` (#1163)+- **Floccus Integration:** Karakeep [now supports](https://github.com/floccusaddon/floccus/pull/1953) bi-directional sync with browser bookmarks using [Floccus](https://floccus.org/). 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 (#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 (#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](https://docs.karakeep.app/next/Guides/singlefile#handling-existing-bookmarks).+- Configure whether you want to see archived bookmarks in lists or tags or not (#1505) - @xuatz+- Added Algolia-based search to docs+- Added "deleted" webhook event (#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 (#1515) - @AdrianAcala+- Fixed tag drag-and-drop issues on Firefox (#1016) - @haappi+- Added log rotation for linux installations (#1471) - @vhsdream+- You can now run Karakeep container as a non-root user for better security.++# For Developers π οΈ+- Added `?sortOrder` parameter for resource sorting (#1398) - @xuatz+- New endpoint for tag creation+- PUT operations for bookmarks are now idempotent (e.g. adding to list) (#1427) - @xuatz+- Added PATCH method support to CORS headers (#1489) - @spasche+- **Documentation:**+ - Added documentation for the asset upload APIs+ - Fixed JSON examples in MCP documentation (#1400, #1419) - @jk, @jakeasmith+ - Expanded Meilisearch upgrade guides (#1436) - @thiswillbeyourgithub++# Community Projects π‘+- **Python-based SDK for Karakeep:** [karakeep-python-api](https://github.com/thiswillbeyourgithub/karakeep_python_api) - @thiswillbeyourgithub+- **Freshrss Importer:** [freshrss-to-karakeep](https://github.com/thiswillbeyourgithub/freshrss_to_karakeep) - @thiswillbeyourgithub++# Screenshots πΈ++## The Share List Modal+<img src="https://github.com/user-attachments/assets/688d2389-65c1-4e0e-87ba-233d5b0ffaae" alt="Screenshot 2025-06-08 at 10 35 45@2x" width="500" height="auto">++## Tabbed Layout on smaller screens+<img src="https://github.com/user-attachments/assets/affc1426-fe1f-46df-9567-196c25d13107" alt="Screenshot 2025-06-08 at 10 37 11@2x" width="500" height="auto">++## Reader Mode in the app+<img src="https://github.com/user-attachments/assets/14f438ea-d558-40eb-8d05-84d017d46a89" alt="simulator_screenshot_1322546F-62F2-4129-89F7-7D77366179B6" width="300" height="auto">++# 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`.diff --git a/release-notes/2025-07-20-v0.26.0.md b/release-notes/2025-07-20-v0.26.0.mdnew file mode 100644index 00000000..9becdea4--- /dev/null+++ b/release-notes/2025-07-20-v0.26.0.md@@ -0,0 +1,114 @@+# 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 βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++# 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](https://tally.so/r/wo8zzx)!**++# 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 (#1627 by @lexafaxine)+- **File Upload Support:** Added markdown file upload support (#1672 by @rodsnts)+- **Usage Statistics:** New user stats page showing tons of stats about your bookmarks and usage of karakeep (#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 (#1265)+- **Server Improvements:**+ - **S3 Storage Support:** Option to store assets in S3-compatible storage (#1703)+ - **Prometheus Monitoring:** We're now exposing a Prometheus endpoint for monitoring stats about the server (#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 (#724)+- **Reddit Crawling:** Reddit posts will now get a more relevant banner image (#1302 by @birnam)++# UX Improvements β¨+- Prioritize crawling user-added links over bulk imports (#1717)+- Mobile app now has user setting for default bookmark view mode (#1723 by @xuatz)+- More lenient JSON parsing for LLM responses (#1267)+- Tweaks to mobile app icon padding with 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 (#1540)+- Added confirmation dialog for user deletion in admin panel (#1649 by @deepanshu2711)+- Added tag clearing functionality to tag list in the mobile app(#1595 by @Ashok28)+- Always visible search bar in the mobile app's tags list (#1596 by @Ashok28)++# Fixes π§+- Fixed OAuth creation failure due to missing UserSettings table (#1583)+- Fixed webhook not firing on deletion (#1613)+- Normalized leading hashes in tag names (#1351 by @Mostafa-Wahied)+- Fixed import/export icons being swapped (#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 (#1622)+- Fixed public image signed tokens for better caching+- Fixed clear parent button in edit list dialog (#1742)+- Fixed running workers in production without tsx for lower resource usage (#1673)+- Fixed get-lists MCP tool (#1697 by @hametovbr)+- Fixed image quality slider in mobile showing excessive decimal places (#1735)+- Fixed mobile app crash when bookmark doesn't have archive or screenshot (#1584)+- Migrated from Puppeteer to Playwright (#1296 by @maelp)+- Video downloader now properly logs yt-dlp errors (#1624 by @irobot)++# For Developers π οΈ+- Added Helm chart support ([link](https://github.com/karakeep-app/helm-charts)). (#1350 by @sheyabernstein)+- **Build & Deployment:**+ - A much fancier linux installation script (#1576 by @vhsdream)+ - Added start-dev.sh script for easier development (#1628 by @xuatz)+ - Upgraded to [email protected] (#1544 thanks to @xuatz)+ - Migrated from ESLint to oxlint for faster linting (#1642 by @xuatz)+ - We now have a `CLAUDE.md` file to help the vibe coders out there.++# Community Projects π‘++### [Karakeeper](https://apps.apple.com/us/app/karakeeper-for-karakeep/id6746722790)++3rd Party Safari Extension - *by @simplytoast1*++<img width="640" height="874" alt="Screenshot 2025-07-20 at 2β― 16 48@2x" src="https://github.com/user-attachments/assets/03f8baf1-b8a6-4c92-9248-1127dcb72587" />++### [Karakeep Homedash](https://github.com/CodeJawn/karakeep-homedash)++*by @CodeJawn*++<img width="1918" height="1060" alt="image" src="https://github.com/user-attachments/assets/35e0614e-9d92-4cf1-9d53-c5c3dc1ab4c9" />+++# Screenshots πΈ++## Usage Stats++<img width="2882" height="2812" alt="image" src="https://github.com/user-attachments/assets/2add1f9c-5bf3-4307-b6c7-f9e347f45bc8" />++## The new Sign In page++<img width="1072" height="1202" alt="Screenshot 2025-07-20 at 1β― 58 50@2x" src="https://github.com/user-attachments/assets/4e59daeb-04e9-456c-8e17-4ec9bec0763b" />++## Recent Searches++<img width="1502" height="338" alt="Screenshot 2025-07-20 at 1β― 59 55@2x" src="https://github.com/user-attachments/assets/9bf99d12-e900-44a9-8e1c-c8a1293b5a9b" />++## Reader Mode++<img width="2318" height="1558" alt="Screenshot 2025-07-20 at 2β― 04 29@2x" src="https://github.com/user-attachments/assets/f35c52e9-4858-4fa6-be60-8c2b3f2e54ab" />+++# 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.diff --git a/release-notes/2025-09-07-v0.27.0.md b/release-notes/2025-09-07-v0.27.0.mdnew file mode 100644index 00000000..76a11c37--- /dev/null+++ b/release-notes/2025-09-07-v0.27.0.md@@ -0,0 +1,91 @@+# 0.27.0++Welcome to the 0.27.0 release of Karakeep! This release brings website-aware previews, cookies support, redesigned background jobs page, and a lot of fixes and cleanups that accumulated over the past 1.5 months. Huge thanks to our contributors in this release:+@Ahmed-Abdel-karim, @qixing-jk, @youenchene, @Drashi, @thiswillbeyourgithub, @xuatz, @haappi, @CrazyWolf13, @landonepps, @dvdpearson, @vivienbcr, @yinan-c, @packetmonkey, @liCells and+everyone who reported issues and tested changes!++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++And in case you missed it from the last release, we now have a βοΈ managed offering βοΈ for those who don't want to self-host. We're still in private beta (you can signup for access [here](https://tally.so/r/wo8zzx)) and gradually letting more and more users in.+++# New Features π+- [Experimental] Karakeep now detects specific websites and renders a customized cards for them. We're starting with 4 special renders (and are accepting contributions for more):+ - X (twitter): Now shows a tweet embed by default.+ - Amazon: A card that shows the product.+ - Youtube: Renders a youtube embed (i.e. a player) by default.+ - Tiktok: Renders a tiktok embed (i.e. a player) by default.+ - If you want to see more websites supported, don't hesitate to send PRs. This is meant to evolve into karakeep understanding the different bookmark types (e.g. products, articles, etc) and showing more specialized cards for each type.+- Background Jobs page got a complete redesign to better explain the different jobs (#1551)+- Cookie support for crawling login-protected sites (#1664 by @liCells)+ - You can now pass a list of cookies for karakeep to use while crawling to access session-protected websites. Checkout the documentation of `BROWSER_COOKIE_PATH` [here](https://docs.karakeep.app/configuration).+ - **Note:** This is an advanced feature. Cookies are extremely sensitive. Make sure you're handling them carefully. Also note that the cookies that you set are going to be shared with all the users in your instance. [SingleFile](https://docs.karakeep.app/Guides/singlefile) remains the recommended way for accessing login-protected websites.+- GIF asset support (#1876 by @Drashi)+- Updated default chrome container to v124, make sure to update yours as well.+++# UX Improvements β¨++- Browser Extension:+ - Theme selection and theme-adapting icon support (#1894 by @qixing-jk)+ - Constrain height of list and tag selectors to prevent viewport overflow (#1895 by @qixing-jk)+ - Both will come in the next extension release (aka soon).+- Mobile:+ - Various mobile theme fixes (#1872)+ - Edit menu item on bookmark card+ - Add context aware sharing button in mobile app (#1785 by @xuatz)+ - Delete button and creation dates on info page+- Render author, publisher, and publish date in bookmark view+- Configurable number of grid columns in the bookmark grid (#1713)+- Show loading indicator while the karakeep export is being generated (#1787/#1870 by @Ahmed-Abdel-karim)+- Hide AI settings tab if inference isnβt configured (#1781)+- Render human tags before AI tags (#1740 by @haappi)+- Preserve selected bookmark preview section in link preview via query params+- Hide bookmark actions from the navbar when no bookmark grid is shown+- Dark mode titles fixed for public lists+- Render AI summary in Markdown (#1869 by @youenchene)+- Bookmark skeleton while search results are loading++# Fixes π§++- **[Security]** CSP policies on asset-serving paths+ - Fixes potential self-XSS on user uploaded assets.+ - Check the security advisory [here](https://github.com/karakeep-app/karakeep/security/advisories/GHSA-7cj2-fr83-g2wj).+ - Special thanks to @Skelmis for the disclosure!+- Speed improvements:+ - Avoid prefetching assets and tags which should make the tags page loading smoother+ - Fixed a big (accidental) performance bottleneck in the API endpoints caused by API key validation. Re-login in your mobile app (and regenerate your API keys if you use any) for a significantly noticeable speed improvement.+- Queue DB respects configured WAL mode+ - This fixes issues of slow imports and frequent locked databases+ - Enabling WAL is highly advisable+- fix search query getting rest when bookmark preview is closed+- Handle lists with slashes during imports and truncate long list names for more resilient imports+- Donβt mark inference job as failed when content is missing (#1666)+- fix WebView deceleration rate on iOS (#1835 by @landonepps)+- Fix PDF detection when Content-Type includes charset (#1677)+- Rule engine: deleting an action now doesn't auto-save (#1858)+- Fix feed worker to use proxy when it's configured+- Web UI will poll for longer (incrementally) as bookmarks are being fetched.+- Fixed an issue with using SingleFile with S3 caused by unaccepted chars in filenames (#1765)+- fix admin API route to be under /v1+- fixed assets incorrectly marked as pending summarization+- Add max output tokens env variable to control the max allowed number of tokens returned by the LLM (to control the costs).++# For Developers π οΈ++- Prometheus:+ - Workers now also export prometheus metrics. You need to enable the metrics endpoint and the port to crawl them.+ - Trpc latency was switched to histograms+ - `karakeep_` prefix was added to all exported metrics (by @CrazyWolf13), you'll need to update your dashboards.+- Enable/disable specific workers via env variables+- You can now upload video attachments to bookmarks from the API (#1847 by @packetmonkey)++# 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`.++Also upgrade your `chrome` container to `124` if you have it pinned.diff --git a/release-notes/2025-09-13-v0.27.1.md b/release-notes/2025-09-13-v0.27.1.mdnew file mode 100644index 00000000..e74c4488--- /dev/null+++ b/release-notes/2025-09-13-v0.27.1.md@@ -0,0 +1,9 @@+This is a hotfix release for [0.27.0](https://github.com/karakeep-app/karakeep/releases/tag/v0.27.0).++# π Fixes++* fix: Fix ranking of search results. fixes #1922 - @MohamedBassem in 3bae3aad+* fix: fix migration failing when no user settings are set. fixes #1919 (#1920) - @halkeye in 2cb1b28a+* fix: fix 5xx on invalid api key - @MohamedBassem in 20f4e471+* fix: migrate systemd config to the new worker path on update. fixes #1889 - @MohamedBassem in e5dea956+diff --git a/release-notes/2025-11-08-v0.28.0.md b/release-notes/2025-11-08-v0.28.0.mdnew file mode 100644index 00000000..44cd7fb5--- /dev/null+++ b/release-notes/2025-11-08-v0.28.0.md@@ -0,0 +1,89 @@+# 0.28.0 (20k stars β)++Welcome to the 0.28.0 release of Karakeep! We've have hit 20k stars on Github π (well 21k because I was too late with the release)! Thanks a lot for your support throughout this journey! This release brings a refreshed import pipeline, uploading custom attachments, revamped tags page, inline checklists, and a bunch of quality-of-life touches across the web app, extension and mobile app. Huge thanks to @BOTkirial, @qixing-jk, @@maya-doshi, @BenjaminMichaelis, @cloudchristoph, @claytono, as usual @xuatz and everyone who shipped code, triaged bugs, or shared feedback for this release.++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++And in case you missed it, we now have a βοΈ managed offering βοΈ for those who don't want to self-host. We're still in private beta (you can signup for access [here](https://tally.so/r/wo8zzx)) and gradually letting more and more users in.+++# New Features π++- Revamped import experience with progress tracking (#2001)+- Revamped Tags page that adds search and pagination to better serve users with thousands of tags (#1987)+- You can now upload custom attachments to bookmarks (#2100)+- When deleting a list, you can now optionally delete all its children (#1989)+- Server overview highlights service dependency health.+- Inline checklist toggling for text bookmarks (#1933) β @BOTkirial+- With every release, you'll be prompted to view what's new in that release from inside the app.+- You can now pass custom headers from the mobile app to the server (#2103)+- Extension improvements:+ - Tab bookmark badge indicator by @qixing-jk shows when a page is already bookmarked (#1745)+ - You can now write notes directly after saving a bookmark in the extension (#2104)++# UX Improvements β¨++- Grid view controls expose title/tag toggles and image fit options (#1960)+- Bookmark cards can surface saved notes across web and mobile (#2083) β @xuatz+- Manage Lists modal is searchable for faster sorting (#2029)+- The tags page now has a "Create Tag" button (#1942)+- You can now regenerate the API key without having to recreate it.+- New `title:` seach qualifier for searching bookmarks by title (#1940)++# Fixes π§+- β οΈ (Potentially breaking change) β οΈ Stricter URL valdaition to protect against SSRF attacks (#2082)+ - Webhook requests now go through the proxy if there's one configured+ - All server-initiated requests (including webhooks) to internal IP addresses are now blocked by default unless explicitly allowed via `CRAWLER_ALLOWED_INTERNAL_HOSTNAMES`. If your webhooks are hitting internal services, you'll have to allowlist them via `CRAWLER_ALLOWED_INTERNAL_HOSTNAMES`.+ - Monolith now honors the configured crawler proxy.+ - Metascraper logo extraction now respects the crawler proxy.+- Crawler memory footprint shrinks with targeted optimizations (#1748)+- Allow karakeep to use newer openai models that was previously failing because of deprecated max_tokens (#2000) - @BenjaminMichaelis+ - You'll need to set `INFERENCE_USE_MAX_COMPLETION_TOKENS=true` in your `.env` file to use the new models. This is eventually going to become the default.+- Admin maintenance jobs respect abort signals to stop gracefully+- Search input no longer crashes on percent signs and also works correctly with IME composition+- Fixed a crash when sharing a list publicly that didn't have any bookmarks (#1990)+- Screenshots are now stored as jpegs instead of pngs to reduce file size+- Fixed a bug that was preventing tag merging (#1938)+- RSS imports can apply feed categories as tags (#2031)++# For Developers π οΈ+- Create bookmark API returns 200 instead of 201 when a bookmark already exists+- CLI Improvements:+ - New commands to migrate data from one server to another+ - New command to dump a full account archive+ - A new wipe command to selectively clean up data from the account++# Community Projects π‘++### [Karakeeper](https://apps.apple.com/us/app/karakeeper-for-karakeep/id6746722790)++3rd Party iOS/Safari Client - *by @simplytoast1*++Karakeeper now is providing an alternative iOS native mobile/desktop client for Karakeep beyond its existing functionality of providing a safari extension.++### [Karakeep Sync](https://github.com/sidoshi/karakeep-sync)++A syncing tool for Karakeep - *by @sidoshi*++A rust-based syncing tool that syncs: Hacker News upvotes, Reddit saved posts, Github stars and Pinboard bookmarks automatically to Karakeep!+++# Screenshots πΈ++## Inline Checklists+<img width="1230" height="806" alt="Screenshot 2025-11-08 at 8β― 55 18@2x" src="https://github.com/user-attachments/assets/c092d903-eb6f-40c6-aee6-1ce6127f67e8" />++## Import Sessions+<img width="1814" height="762" alt="Screenshot 2025-11-08 at 8β― 58 21@2x" src="https://github.com/user-attachments/assets/dfcb856b-6a63-4d7a-ba4b-ce2ca83bc844" />++## Service Health Indicators+<img width="1874" height="540" alt="Screenshot 2025-11-08 at 8β― 56 00@2x" src="https://github.com/user-attachments/assets/7835f1ad-239d-477c-8e00-951e4a09f8c6" />+++# 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, bump the version and then run `docker compose pull && docker compose up -d`.diff --git a/release-notes/2025-11-29-v0.29.0.md b/release-notes/2025-11-29-v0.29.0.mdnew file mode 100644index 00000000..50975f80--- /dev/null+++ b/release-notes/2025-11-29-v0.29.0.md@@ -0,0 +1,66 @@+# 0.29.0++Welcome to the 0.29.0 release of Karakeep! This release ships some of our most awaited features. Collaborative lists, automated bookmark backups, search auto complete, highlighs are getting notes and search, and the mobile app is getting some more love. As usual thanks to @aa-ko, @fivestones, and everyone who shipped code, triaged bugs, or shared feedback for this release.++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++And in case you missed it, we now have a βοΈ managed offering βοΈ for those who don't want to self-host. ~~We're still in private beta (you can signup for access [here](https://tally.so/r/wo8zzx)) and gradually letting more and more users in.~~ We're in public beta now and you can signup [here](https://cloud.karakeep.app) π.+++# New Features π++- Collaborative lists are here! (#2146, #2152)+ - You can now invite collaborators to your lists and manage their access levels between viewers and editors.+ - This was the most requested feature on the roadmap, and it's now here!+- Automated bookmark backups you can schedule once and forget (#2182)+ - Currently it only captures non-asset bookmarks, but I'm planning to include lists, tags, and other metadata in the future.+- Search gets autocomplete so you can find the right filters and terms faster (#2178)+- Highlights overhaul: notes + search bar on web, plus a dedicated highlights page on mobile (#2154, #2155, #2156, #2157)+- Mobile catches up with smart list creation and an all-tags screen (#2153, #2163)+- Crawler domain rate limiting to avoid getting throttled by external sites (#2115)+ - Configure it with `CRAWLER_DOMAIN_RATE_LIMIT_WINDOW_MS` and `CRAWLER_DOMAIN_RATE_LIMIT_MAX_REQUESTS`.+- Import from MyMind (#2138)++# UX Improvements β¨++- Sidebar typography and colors should feel nicer (specially in dark mode).+- Page titles are now correctly displayed in the browser tabs.+- We have a friendlier 404 page for bookmarks/lists that don't exist.+- You can now see stats about the source of your bookmarks in the usage stats page (extension, web app, mobile app, etc).++# Fixes π§++- Prompts lazily load `js-tiktoken` which should cut between 70-150MB of karakeep's memory usage (#2176)+- The edit dialog wasn't correctly showing the extracted text from assets, this is now fixed (#2181).+- IP validation allowlisting now allows bypassing all domains by setting `CRAWLER_ALLOWED_INTERNAL_HOSTNAMES` to `.`.+- Fix a worker crash when hitting invalid URLs with proxy enabled.++# For Developers π οΈ+- GET `/api/version` endpoint for getting server version (#2167)+- More visibility: HTTP status Prometheus counters, failed_permanent worker metric, and system metrics on web/worker containers (#2117, #2107)+- Documentation updates for `LOG_LEVEL` and Raycast links (#2166, #1923) by @aa-ko and @fivestones+++# Screenshots πΈ++## Collaborative Lists++<img width="1342" height="840" alt="Screenshot 2025-11-29 at 6β― 23 18@2x" src="https://github.com/user-attachments/assets/f19f9951-c460-413c-9757-6014a7ec4f7e" />+++## Automated Backups++<img width="1874" height="1540" alt="Screenshot 2025-11-29 at 6β― 23 57@2x" src="https://github.com/user-attachments/assets/65dc7e0e-3ab3-4243-b451-5ef3a3e7130b" />+++## Search Autocomplete++<img width="1492" height="636" alt="Screenshot 2025-11-29 at 6β― 24 54@2x" src="https://github.com/user-attachments/assets/ed2f7a61-835f-4ee6-8940-657110932526" />++# 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, bump the version and then run `docker compose pull && docker compose up -d`.diff --git a/release-notes/2025-12-03-v0.29.1.md b/release-notes/2025-12-03-v0.29.1.mdnew file mode 100644index 00000000..ed0ab031--- /dev/null+++ b/release-notes/2025-12-03-v0.29.1.md@@ -0,0 +1,3 @@+# 0.29.1++A patch release for [0.29.0](https://github.com/karakeep-app/karakeep/releases/tag/v0.29.0) with the fix of NextJs CVE: CVE-2025-66478diff --git a/release-notes/2025-12-11-v0.29.2.md b/release-notes/2025-12-11-v0.29.2.mdnew file mode 100644index 00000000..d81a243e--- /dev/null+++ b/release-notes/2025-12-11-v0.29.2.md@@ -0,0 +1 @@+Upgrading Nextjs to patch two new vulnerabilities in react CVE-2025-55184 & CVE-2025-55183. This is on top of the critical vulnerability (CVE-2025-66478) that was patched in 0.29.1.diff --git a/release-notes/2025-12-12-v0.29.3.md b/release-notes/2025-12-12-v0.29.3.mdnew file mode 100644index 00000000..6a858c12--- /dev/null+++ b/release-notes/2025-12-12-v0.29.3.md@@ -0,0 +1 @@+Well. Upgrading Nextjs one more time to patch CVE-2025-67779.diff --git a/release-notes/2026-01-01-v0.30.0.md b/release-notes/2026-01-01-v0.30.0.mdnew file mode 100644index 00000000..f6e79229--- /dev/null+++ b/release-notes/2026-01-01-v0.30.0.md@@ -0,0 +1,99 @@+# 0.30.0 (New year release π)++Welcome to the 0.30.0 release of Karakeep and happy new year! This release comes with "2025 wrapped" (a bit late), PDF archives, new reader settings, avatars, reddit crawling improvements, and more! Huge thanks to our contributors for this release @esimkowitz, @Moondragon85, @rzxczxc, @colado, @Yeraze, @eriktews and everyone who shipped code, triaged bugs, or shared feedback for this release.++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++And in case you missed it, we now have a βοΈ managed offering βοΈ for those who don't want to self-host. We're in public beta now and you can signup [here](https://cloud.karakeep.app) π.++# New Features π++- 2025 Wrapped is here to celebrate your year in Karakeep (#2322).+- PDF archives+ - Archive bookmarks as PDFs, generated automatically during crawling or on-demand (#2309).+ - Set `CRAWLER_STORE_PDF=true` to enable auto PDF archiving.+- Unified reader settings (font, size, etc) across all devices with per-device overrides (#2230). By @esimkowitz!+- Better metadata extraction:+ - Reddit posts should now be crawled correctly, and banners should be fetched more reliably.+ - Fixed YouTube thumbnail and author extraction.+ - Fixed Amazon product image extraction (where it was sometimes showing the prime logo) (#2204, #2108). By @Yeraze+- Upload custom user avatars for more personal profiles (#2296).+- AI Setting customization:+ - Customize tag styling (case, separators, language) per user. It's highly recommended to set the tag style for more consistent tags (#2312).+ - Per-user toggles to disable auto-tagging and/or auto-summarization (#2275).+- Others:+ - Import libraries from Matter with full export support (#2245). By @Moondragon85+ - Bulk remove bookmarks from lists (#2279).+ - Add a new rule condition to rule engine: "URL Does Not Contain" (#2280).+ - Configure an OpenAI proxy via `OPENAI_PROXY_URL` (#2231). By @rzxczxc+ - Added `is:broken` search qualifier to show links that failed crawling (#2225).+ - Edit list now in the mobile app (#2310). By @colado++# UX Improvements β¨++- Our docs got a facelift! The docs got some styling, the pages got re-organized and we now have a "Using Karakeep" section that explains some of the core concepts of Karakeep.+- Replace bookmark banners and download attachments directly from the drop down menu (#2328).+- Sidebar scrollbar looks cleaner, and pending list invites show as a badge in the sidebar.+- Bookmark edit dialog now includes notes.+- Bookmark owner avatars now show up in collaborative lists.+- Mobile UI/UX improvements:+ - Fixed title on mobile to be at most 2 lines long.+ - Mobile settings screens should now feel more native (#2307).+ - OLED-friendly colors in the Android app matching the colors of the ios app (#1958).+ - Toasts on iOS now appear correctly above the open modals (#2320). By @colado+ - Shared lists now appear in a dedicated subsection on mobile.+ - Adding a bookmark to a list now shows a spinner during loading (#2283).+ - Server version now appears in mobile settings (#2276).+ - Fixed the confusing "tick button" beside the server address during login.++# Fixes π§++- Fixed missing db indicies that was causing slow bookmark queries (#2246, #2287).+- Improved Ollama summaries by using the generate endpoint (#2324). By @eriktews+- Fixed HTML bookmark imports failing on empty folder names (#2300).+- Fixed non-link bookmarks stuck in pending summarization (#1605).+- Improved tagging prompts and error-page detection.+- Reject spoofed content types on file uploads.+- Preserve failure counts when rescheduling rate-limited domains (#2303).+- Fixed duplicate backdrop buttons in reader view (#2234). By @colado+- RSS feed fetching is now spread over the hour (#2227).+- Asset preprocessing worker timeout is now configurable (91784cd2).+- Fixed bypassing email verification in apiKey.exchange.+- Added limits on number of rss feeds and webhooks per user configurable by admins.+- Fixed a bug where failed crawling leave bookmarks as pending tagging in the admin dashboard.++# For Developers π οΈ++- OpenTelemetry integration with OTLP exporter (#2318, #2321).+- CLI can list users for admins.+- We're now defaulting to Node.js 24 (the current LTS).+- Breaking: In bookmark APIs `includeContent` now defaults to `false`. This change was announced a couple months ago, and is taking effect in this release.++# Community Projects π‘++- Karakeep integration for Home Assistant (#2196) by @sli-cka. Get it from [here](https://github.com/sli-cka/karakeep-homeassistant).++# Screenshots πΈ++## Wrapped 2025++++## Reader Settings++.+++### AI Settings++++++# 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, bump the version and then run `docker compose pull && docker compose up -d`.diff --git a/release-notes/2026-02-22-v0.31.0.md b/release-notes/2026-02-22-v0.31.0.mdnew file mode 100644index 00000000..5499b425--- /dev/null+++ b/release-notes/2026-02-22-v0.31.0.md@@ -0,0 +1,103 @@+# 0.31.0++Welcome to the 0.31.0 release of Karakeep! This release brings synchronized reading progress, LLM-based OCR, a revamped import pipeline, drag-and-drop for lists, highlights on mobile, a lot of mobile polish, and fixes for some long standing bugs. Huge thanks to our contributors for this release @esimkowitz, @WieserDaniel, @chen-ye, @SnowSquire, @mokhovyk, @evan6seven, @ElectricTea, @RobertRosca, @sweepies, @usr3 and everyone who shipped code, triaged bugs, or shared feedback for this release.++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem).++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>++And in case you missed it, we now have a βοΈ managed offering βοΈ for those who don't want to self-host. You can signup [here](https://cloud.karakeep.app) π.++# New Features π++- Synchronized reading progress across all your devices (#2302). By @esimkowitz!+ - Your reading position is now saved and synced, so you can pick up right where you left off on any device.+- LLM-based OCR as an alternative to Tesseract (#2442)+ - You can now use your configured LLM for OCR instead of Tesseract, which produces significantly better results for image and asset bookmarks.+- Revamped Import pipeline (#2378)+ - The import experience got another big overhaul: a new import details page (#2451), a dedicated low-priority queue for import crawling (#2452), better progress tracking, ability to pause an import and more resilient error handling.+- Drag-and-drop bookmarks into lists (#2469)+- Highlights support on mobile (#2494)+ - You can now view and create highlights in the mobile app's reader view.+- AI tag suggestions: instructs the model to limit auto-tagging to a subset of your existing tags for more consistent results (#2444).+- Export lists in backups and exports (#2484)+ - Automated backups and full exports now include your lists.+- Others:+ - Retry buttons for dangling (aka pending) bookmarks in the admin panel (#2341).+ - Add signup support to the mobile app.+ - OpenAI service tier configuration via `OPENAI_SERVICE_TIER` (#2339). By @RobertRosca!+ - Import from Instapaper (#2434). By @WieserDaniel!+ - Privacy-respecting bookmark debugger admin tool (#2373)+ - MCP server now supports custom configurable HTTP headers (#2436). By @chen-ye!+ - New search qualifiers:+ - `source:` filter to search by bookmark source (mobile, extension, web, etc.) (#2465).+ - `tag:` alias for `#` and `!` alias for negation (#2425).+ - New "Title Contains" condition in the Rule Engine (#2354). By @mokhovyk!++# UX Improvements β¨++- Mobile app overhaul:+ - Native tabs and more native-feeling screens.+ - Animated UI feedback in the sharing modal (#2427).+ - Show bookmark count in the all lists view.+- Better looking content fetching loading state in the bookmark preview.+- Two-phase metadata updates so bookmarks show up faster while crawling is still in progress (#2467).+- Links to apps, extensions and docs in the profile dropdown.+- Extension autofocuses on note field on open (#2366). By @SnowSquire!+- Improving the visual consistency of the settings page.+- Opt-in OAuth auto-redirect for single-provider passwordless setups (#2483)+- Add a download button for assets in the bookmark options menu.+- API keys now show their last-used dates to better identify unused keys.+- Fix masonry overflow in bookmark grids (#2400). By @evan6seven!+- Hide confusing `No suggestions` message when no search suggestions are available.++# Fixes π§++- [Security] Sanitize reddit's crawling output to prevent stored XSS. This was reported by @ByamB4 and published as a github advisory (GHSA-mg93-f9mw-wpgj).+- Eliminated O(nΒ²) parsing of Netscape bookmark imports (#2338).+- Smart lists can now be used in search qualifiers and in other smart list queries (#2470)+- Parallelize content extraction in the crawler worker for faster crawling.+- Batch meilisearch indexing requests for better performance (#2441).+- Auto dismiss dialogs during crawling that might have caused worker crashes before.+- Use user's preferred language for manual summarization (#2429).+- Accept more permissive RSS feed content types (#2353). By @ElectricTea!+- Fix clipping of reader view in smaller screens.+- Fix overscrolling in some setting pages (e.g. AI settings).+- Stop theme flashes with Cloudflare Rocket Loader (#2340). By @sweepies!+- Retry 403, 429 and 5XX status codes from the crawler.+- Lower priority of recrawling and mass admin actions to avoid starving interactive traffic.+- Fix scrolling in manage lists/edit tags when inside a dialog (#2258).+- Respect archived display behavior setting in mobile lists and tags (#2499).+- Fix flicker on closing bookmark preview on search page.+- Share PDFs from the mobile app as files instead of links.+- Fix high CPU usage of browser container after large imports due to leaking contexts. (#2503)+- Reader settings preview in the mobile app now matches reader view formatting (#2365). By @esimkowitz!+- When saving an image or a link from a page using "Add to Karakeep" menu item, the title of the original page is no longer incorrectly used for that link.++# For Developers π οΈ++- Docker images moved from Alpine to Debian.+- OpenTelemetry instrumentation for database queries and extra tracing in OTEL traces (#2453).+- Prometheus metric for bookmark crawl latency (#2461).+- New `checkUrl` API endpoint to check if a URL is already bookmarked.+- `attachedBy` field in the update tags API endpoint to mark the tag as added by human or AI (#2281).+- Upgraded to Expo SDK 54, React 19.2.1, and Node.js 24.+- CLI can now search bookmarks (#2426).++# Screenshots πΈ++### Reader Progress+++++### Import Details+++++# 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, bump the version and then run `docker compose pull && docker compose up -d`.diff --git a/release-notes/2026-05-08-v0.32.0.md b/release-notes/2026-05-08-v0.32.0.mdnew file mode 100644index 00000000..998ece51--- /dev/null+++ b/release-notes/2026-05-08-v0.32.0.md@@ -0,0 +1,160 @@+Welcome to the `0.32.0` release of Karakeep! The mobile app is getting a major redesign by @esimkowitz so that it feels more native and friendly to use. Our long-overdue Safari extension is now available on the app store. Karakeep is now more AI-agents friendly with an official skill, revamped and more powerful CLI, granular API keys (and more coming in the next release). SingleFile is now integrated inside the karakeep extension itself for better crawling of authenticated pages. Keyboard shortcuts for faster actions across the app. And tons of fixes!++This release has a huge list of contributors. Some frequent faces, and many contributing their first PRs. Thanks @esimkowitz, @Mxrk, @beluga73, @Ahmed-Abdel-karim, @GSAlex, @cinconueves, @keslerm, @xingzihai, @howwohmm, @vbalko-claimate, @MaximePinot, @apo-mak, @NikhilChowdhury27, @maxim-mityutko, @xuatz, @ir31k0, @Joly0, @larsborn, @venku122, @lmgarret, @hoilc, @zerone0x, @mrInvincible29, @Go2Engle, @faximan.++*Note: the changes mentioned here for the extension and mobile releases will need to go through the different store (apple, google, mozilla) reviews. So it might take a couple of days until all of them are released.*++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem). Also share Karakeep's managed offering (βοΈ [link](https://cloud.karakeep.app)) to your friends who're not into selfhosting. We're offering yearly subscriptions now.++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>+++# New Features π++* Karakeep's **Safari extension** is now available on the App Store ([link](https://apps.apple.com/gb/app/karakeep-app/id6479258022?platform=mac)), closing Karakeep's oldest open issue (#10).+* Huge **mobile app revamp lead by @esimkowitz**:+ * More native screens, headers and action buttons by @esimkowitz (#2685)+ * Customizable reader toolbar by @esimkowitz (#2527)+ * Add ability to keep screen on for bookmark reading by @esimkowitz (#2691)+ * Opening links in the reader view now opens them in an in-app browser so that you can quickly go back to where you left by @esimkowitz (#2696)+ * Add ability to default open links in external browser by @xingzihai (#2516)+* **Karakeep for Agentic usage**: Our goal is to make Karakeep very AI agents friendly. This will allow agents (OpenClaw, Hermes, etc) to find and hoard interesting content on your behalf, provide weekly digests, and more.+ * We're publishing an official skill for karakeep on ClawHub and skills.sh (details [here](https://docs.karakeep.app/next/integrations/agentic-skills)). Those skills teach the agent karakeep's concepts and how to use the CLI.+ * CLI improvements:+ * The CLI also got major improvements allowing it to manage more aspects for bookmarks, lists, and tags. Also got more AI friendly formatting, etc.+ * To avoid having to pass the address and API key with every request, karakeep can now store the auth config in a file and use it for further requests. Init that file with `karakeep auth init`.+ * If you're afraid to give agents full Read/Write access to your data, API keys now have granular scopes to all resources. Which means you can give agents access to your bookmarks but not administrative actions (like deleting users), etc.+* **Keyboard Shortcuts**: You can now do more with the keyboard, as we added support for navigating the bookmark grid with keyboard shortcuts, and taking actions such as favouring/archiving and doing bulk actions. This is the beginning, and please send feature requests for the extra features you need.+* **Extension improvements**:+ * [Experimental] The extension can now crawl bookmarks from the client-side eliminating the need of using the SingleFile extension separately from Karakeep (Powered by SingleFile core). This allows you to store pages that are behind authentication or unreachable from your Karakeep server. It's currently opt-in until stable, and then will become the default. Enable it from the extension settings (#2197).+ * Added support for manual save (instead of the default save on open) by @keslerm (#2693)+* **More import sources**:+ * Add support for importing from OneTab by @apo-mak (#2495)+ * Add support for importing from Readwise Reader by @cinconueves (#2690)+* **Others**:+ * Karakeep MCP now has an update-bookmark tool by @vbalko-claimate (#2717)+ * Add support for writing rule engine rules based on bookmark source by @xingzihai (#2547)+ * Add support for configuring OpenAI reasoning effort by @cinconueves (#2718)+ * New extensive event logging for events that happen all over the app. More info about how to enable it [here](https://docs.karakeep.app/configuration/environment-variables#monitoring).+++# UX Improvements β¨++* Visual revamp for the bookmark preview page with nicer colors and ability to collapse the sidebar (f500129c).+* Visual revamp for the "All lists" page showing list privacy settings and number of items in each list (145dda9d).+* List and tags page headers now show more info about the content and type of the list/tag (#2749)+* Quickly favourite and archive a bookmark by new buttons that appear on hover (98e173d8).+* Haptic feedback on mobile sidebar navigation (f91ec531).+* Show "+" in the tag count badges when more pages exist by @zerone0x (432235be).+* In the add bookmark to list dialog, you no longer need to explicitly save the selection thanks to @xingzihai (#2629)+* The default new list emoji changed from "π" to "π". Maturity, I guess?+* You can now add multiple lists to the same rule engine condition by @Ahmed-Abdel-karim (#2620)+* Timestamps across the app are now correctly localized instead of showing the server's timezone (#2682)+++# Fixes π++* **Important Security fixes**:+ * Reported by @tahirsercan (GHSA-g647-327m-79g9)+ * Fix SSRF validation bypass caused by redirects in crawler and video worker+ * Those issues were reported by Sami Zayn:+ * Add missing ratelimits for the changePassword endpoint+ * Sanitize user names before storing them to avoid stored XSS in karakeep emails (#2724)+ * Invalidate existing password reset tokens before issuing a new one (#2722)+ * Reported by @CE2Sec (GHSA-7rx4-c5vx-g8w3)+ * Fix blind SSRF in crawler favicon extraction+ * Add missing ratelimits for bookmark creation and asset upload APIs+* Fix a bug where adding a bookmark to a tag or list didn't appear immediately requiring a refresh.+* Bulk actions used to hammer the server with cache refill requests, those are now debounced.+* Fix adblocker getting skipped due to the URL validation interception.+* Fix "Manage tags" page on iOS not scrolling correctly.+* Prevent highlight popup from stealing focus on Firefox (11dfe74d)+* Fix rare crash in the crawler worker (d197f595)+* Increase max feed url length to 2k chars (07454a6a)+* Fix cropped text in android app when using bold text by @Go2Engle (#2554)+* Fix occasional problems connecting to server from mobile app when it's behind a reverse proxy by @mrInvincible29 (#2559)+* Better extraction for lazy loaded images from content by @zerone0x (#2556)+* Expand $tags/$aiTags/$userTags in AI prompt preview by @zerone0x (#2557)+* Fix sourceUrl not getting saved when creating asset bookmarks via the API by @hoilc (#2574)+* Redact internal server error messages in prod responses (c8a75a0b)+* Correctly parse linkwarden collections during import (722fd8c0)+* Correctly extract TWZ RSS categories as tags by @venku122 (#2589)+* Correctly skip tagging and summarization for assets that fail preprocessing to avoid misleading numbers in the admin panel+* Improve meilisearch request batching for better performance+* Enable configuring monolith timeout and arguments by @NikhilChowdhury27 (#2659)+* Fix openai proxy setting not getting respected by the openai client (#2676)+* Fix formality and tone for a bunch of languages to match that of English+* Use the same proxy URL for all network interactions within the same crawler job run+* Fix parsing archived status for bookmarks imported from Pocket by @howwohmm (#2656)+* Fix parsing archived status and folder for Instapaper bookmarks+* Upgrade playwright to 1.59 to fix browserless compatibility issues+* Stricter full text search matching strategy for bookmarks to provide more relevant results (68e73500)+* Fix unreachable background script on Firefox by @Joly0 (#2649)+* Update default meilisearch version to 1.41 by @ir31k0 (#2643).+ * If you want to update your instance, check out meilisearch's guide [here](https://www.meilisearch.com/docs/learn/update_and_migration/updating).+* Fix truncate long bookmark titles on mobile app by @xuatz (#2699)+* Dedupe crawl jobs using idempotency key by @NikhilChowdhury27 (#2678)+* Add ability to finalize/delete a staged import session that might have been stuck before (#2713)+* Fix low quality video downloads caused by missing ffmpeg dependency to yt-dlp by @MaximePinot (#2721)+* Better ratelimiting for users behind the same IP (e.g. NAT) by including userId in the ratelimit key+* Use relative path for logout redirect to avoid port mismatch by @howwohmm (#2655)+* Skip URL type identification requests if a page is crawled with SingleFile by @GSAlex (#2580)+* Fix text clipping in bookmark card notes by @beluga73 (#2748)+* For CLI based server migrations, tags `attachedBy` is now correctly migrated (462d713f)+++# For Developers π οΈ++* The API docs now have much more extensive documentation. (dd2c6cc0)+* New APIs:+ * For Trigger admin background jobs (4974ce58)+ * For managing feed subscriptions by @larsborn (#2635)+* Map TOO_MANY_REQUESTS to 429 status code in the API instead of internal server error (5b6402f3)+* The docker-compose based dev-env is now more stable and documented thanks to @xuatz (#2149)++# Community Projects π‘++*Checkout our community projects page [here](https://docs.karakeep.app/community-projects).*++* [Karatui](https://github.com/bercribe/karatui): A rust based TUI for managing your karakeep instance by @bercribe in 1c177160+* [Karaclean](https://github.com/lmgarret/karaclean): A Docker sidecar that automatically cleans up Karakeep bookmarks based on declarative YAML rules (e.g. age, tags, lists, etc). @lmgarret++# Screenshots πΈ+++### All Lists Page++<img width="988" height="833" alt="SCR-20260508-ophu" src="https://github.com/user-attachments/assets/905c44c5-73bc-4983-9442-8655b0e12df5" />+++### Mobile App Toolbar++<img width="333" height="549" alt="image" src="https://github.com/user-attachments/assets/5a7a1465-7b6d-4034-b739-8a67e39e2de0" />++### Revamped Bookmark Preview Page++<img width="490" height="786" alt="SCR-20260508-opue" src="https://github.com/user-attachments/assets/d08ab50b-9e55-4768-9ddf-13f41ff6de1b" />++### Keyboard Shortcuts++<img width="487" height="664" alt="SCR-20260508-opza" src="https://github.com/user-attachments/assets/98137562-7f32-4114-9bc0-16d2d808cc16" />+++### Granular API Keys++<img width="834" height="796" alt="SCR-20260508-opmw" src="https://github.com/user-attachments/assets/b0cef659-0697-4c86-95d3-1cd4d36b1389" />++### List Header++<img width="348" height="139" alt="SCR-20260508-oqnx" src="https://github.com/user-attachments/assets/6b9ae48e-9630-4e81-805e-374c2f7aa511" />++### New Extension Settings++<img width="1005" height="874" alt="SCR-20260508-osde" src="https://github.com/user-attachments/assets/e929ff0d-46b3-4c0d-b2c5-cd3040d09fb9" />+++# 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`.diff --git a/release-notes/2026-08-01-v0.33.1.md b/release-notes/2026-08-01-v0.33.1.mdnew file mode 100644index 00000000..f8f39e34--- /dev/null+++ b/release-notes/2026-08-01-v0.33.1.md@@ -0,0 +1,122 @@+# 0.33.1++Welcome to the `0.33` release of Karakeep! The headline of this release is **semantic search**. Karakeep can now generate embeddings for your bookmarks, letting you search by meaning instead of exact keywords (and making auto-tagging noticeably more consistent along the way). The mobile app gets **offline reading**, so you can save articles to your device and read them on a plane, along with new layouts, sorting, and one-tap clipboard saving. **Cookie and GDPR consents** should be something of the past with this release (finally). Plus a big batch of crawler, security and performance fixes.++Thanks to everyone who contributed to this release: @esimkowitz, @joestump, @zerone0x, @ElectricTea, @optix2000, @thiswillbeyourgithub, @jcgoodwin86, @InventorB, @VrtxOmega, @pike00, @KayMi, @TanishValesha, @mahirhir, @moduvoice, @eviaaaaa, @archit-goyal, @CertStone, and everyone who shipped code, triaged bugs, or shared feedback.++*Note: the changes mentioned here for the extension and mobile releases will need to go through the different store (apple, google, mozilla) reviews. So it might take a couple of days until all of them are released.*++> If you enjoy using Karakeep, consider supporting the project [here βοΈ](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem). Also share Karakeep's managed offering (βοΈ [link](https://cloud.karakeep.app)) with your friends who're not into selfhosting.++<a href="https://www.buymeacoffee.com/mbassem" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="auto" height="50" ></a>+++# New Features π++* **Semantic Search** (#2959, #2960) - Search is no longer limited to exact keyword matching. There are now three search modes, switchable from a dropdown in the search bar:+ * `Full text` - the existing keyword search (still the default).+ * `Semantic` [Experimental] - pure meaning-based search powered by embeddings. Searching for "how to make coffee" will find your espresso bookmarks even if they never use those words.+ * `Hybrid` [Experimental] - fuses the results of both.+ * The new mode is also available in the API, MCP and CLI which is going to be the most useful with agents.+ * Semantic search is still new and experimental, so results might not be super accurate yet, but it's a start.+ * β οΈ Semantic search requires embeddings to be enabled, read the upgrade notes for details about how to enable them.+* **Smarter auto-tagging using embeddings** (#2858) - When tagging a new bookmark, Karakeep now looks up semantically similar bookmarks and feeds their existing tags into the LLM prompt as suggestions. The result is a lot less tag sprawl (no more `k8s`, `kubernetes` and `Kubernetes` all coexisting). This also requires embeddings to be enabled, read the upgrade notes for details about how them.+* **Cleaner saved pages** (#2973): the crawler now detects common consent dialogs (cookies and GDPR) and automatically opts out before capturing the article, screenshot and PDF.+* **Offline reading on mobile** (#2957) - The mobile app can now work without a connection:+ * **Save articles for offline**: from a bookmark's "β¦" menu, pick *Make available offline*. The full article is downloaded and kept on device until you remove it.+ * **Recent cache**: everything you browse (bookmark lists, tags, lists, highlights) is now persisted for 7 days, so recently visited screens still open when you're offline.+* **Mobile app improvements**:+ * **New layouts** (#2837): switch between the existing card layout and a new compact list layout. *Note: the default is now the list layout.*+ * **Sorting** (#2777): sort your bookmarks newest-first or oldest-first (overdue, sorry!).+ * **Save from clipboard** (#2868): a new *Clipboard* entry in the "+" menu saves whatever is in your clipboard in one tap. Thanks @InventorB!+ * The manage bookmark sheet now has favourite, archive, share and highlights actions instead of just delete.+* **Karakeep for agentic usage** - continuing where 0.32 left off:+ * **MCP server went from 8 to 29 tools**. Newly added: full list CRUD, full tag CRUD, highlights, `delete-bookmark`, and `get-asset`. Big thanks to @joestump for the list/tag CRUD work (#2917)!+ * **New readable content API** (#2660): `GET /api/v1/bookmarks/{bookmarkId}/content` returns a bookmark's article content as markdown or plain text, cursor-paginated in LLM-friendly chunks that snap to paragraph boundaries.+* **Much faster bookmark metadata** (#2932): Karakeep's pre-flight http request to the website can now contribute to its metadata extraction. This results into some metadata (e.g. title) appearing much faster. A new `CRAWLER_PREFLIGHT_USER_AGENT` option lets you set a user agent for that probe request, and let's just say that a good user agent makes a huge difference.+* The default OpenAI model has changed from `gpt-4.1-mini` to `gpt-5.6-luna` which is half as cheap, though a bit slower given that it's a reasoning model.++# UX Improvements β¨++* **Re-saving an existing bookmark now actually does something** (#2962) - Saving a link you've saved before used to just tell you "Bookmark already exists" and do nothing. Now it re-saves it: the bookmark is un-archived and bumped back to the top of your list.+* **Smarter bookmark previews** (#2975) - Newly crawled pages are now assessed for how well they work in Reader View. Articles continue to open in the clean reader, while homepages, search results, product pages and other non-article content default to a screenshot or a new page-overview panel instead of showing a poor text extraction. You can still switch among the overview, Reader View, screenshot, PDF and archived page from the preview selector.+* **Bulk edit is now one hover away**: instead of first switching bulk edit on from the toolbar, a selection circle appears directly on a bookmark card when you hover it. Selecting one card puts you into bulk edit mode for the rest.+* The sidebar is now wider on large screens, and its scrollbar only appears when you hover it instead of sitting there permanently.+* Mobile polish: a proper loading state while an article is still being crawled, better reader contrast in dark mode, a rebuilt login screen with much clearer connection errors, faster Manage Tags page on large libraries (server-side search instead of loading every tag), iPad/tablet reader toolbar and FAB fixes by @esimkowitz (#2788, #2793, #2794), and a bunch of redundant success toasts removed.+* Karakeep is now installable as a PWA in Chrome again, allowing you to use karakeep on your desktop as if it's one of the apps.+* New **Instagram renderer** (#2836): Instagram posts and reels now render as the actual embedded post in the bookmark preview, joining the existing YouTube, X, TikTok and Amazon renderers.+++# Fixes π++* **Security fixes**:+ * Fixed a DNS rebinding / TOCTOU hole in the crawler's SSRF protection (#2945). Reported by @celinke97 (GHSA-vc53-r298-c6h6).+ * API key and signed asset token verification now use timing-safe comparisons, reported by @xancyber (GHSA-hjm9-gc55-5hgv).+ * Bookmark URLs are now restricted to `http`/`https` on create and update. Reported by @therawdev and @shukla304 (GHSA-6mfw-xrw2-h5x3).+ * Legacy bookmarks with unsafe schemes are filtered out of RSS feeds and Netscape HTML exports, and the exported URLs are HTML-escaped. Reported by @karen93shieh and @MuxiLyuLucy (GHSA-4vx2-9j8p-jg8v).+ * Tag names are now HTML-escaped in Netscape bookmark exports, preventing a crafted or AI-generated tag from breaking out of the `TAGS` attribute when the export is opened in a browser.+ * User-supplied names (user names, list names, inviter names) are HTML-escaped in outgoing emails, fixing HTML injection in the list invitation email. Reported by @therawdev and @shukla304 (GHSA-pvj2-rgwm-r7f8).+ * Password logins are now rate limited (10 attempts per 15 minutes per IP + email). Note that this requires `RATE_LIMITING_ENABLED=true`.+ * Closed account-enumeration side channels in login and password reset.+* Much faster bookmark deletion (#2669): added the missing indexes that should make deletions less IO intensive for large libraries.+* Old completed import sessions are now archived after 30 days: their summary counts are kept, but the per-bookmark staging rows are deleted, which keeps the DB from growing unboundedly after big imports.+* YouTube/video downloads work again - yt-dlp now uses the bundled node as its JS runtime, by @pike00 (#2805).+* Fixed `BROWSER_WEB_URL` failing to resolve on IPv6-only Docker networks by @VrtxOmega (#2863).+* Fixed the X/Twitter renderer, which broke after the API changed its response shape.+* Inline images in SingleFile archives are no longer clobbered by the lazy-load normalization, by @zerone0x (#2928).+* Banner/preview image extraction now works for SingleFile and precrawled archives that inline the image as a data URI.+* Fixed summarization producing garbled output for users running with `INFERENCE_OUTPUT_SCHEMA=json`, by @eviaaaaa (#2926).+* New `OPENAI_TIMEOUT_SEC` option to control the per-request inference timeout, useful for slow self-hosted providers, by @optix2000 (#2876).+* Hardened the tagging prompt: tags are now capped to 1β3 words, and Karakeep explicitly returns no tags for error pages, Cloudflare/CAPTCHA interstitials, cookie banners and login walls - so no more `just a moment` or `cloudflare` tags on failed crawls.+* Fixed the MCP `get-bookmark-content` tool crashing on bookmarks that haven't been crawled yet, by @joestump (#2915).+* Fixed scrolling in the bookmark preview's screenshot view by @VrtxOmega (#2864).+* The browser extension now requests host permissions at runtime for client-side crawling (#2784), instead of asking for them up front.+* Added missing Japanese translations by @mahirhir (#2903) and filled in the missing Korean translation keys by @moduvoice (#2938).+* PDF previews now render via `<embed>` so they display in Safari, by @KayMi (#2806).+* Import progress is now tracked per import job (#2950), so running two imports at once no longer makes their progress bars fight each other. Thanks @jcgoodwin86!+++# For Developers π οΈ++* Docker healthchecks now respect a custom `PORT` by @zerone0x (#2948).+* OAuth providers can now use a configurable ID token signing algorithm via `OAUTH_ID_TOKEN_SIGNED_RESPONSE_ALG`, by @CertStone (#2850).++# Community Projects π‘++*Checkout our community projects page [here](https://docs.karakeep.app/community-projects).*++* [wdoc](https://github.com/thiswillbeyourgithub/wdoc): A RAG-powered document/knowledge querying tool with Karakeep support, by @thiswillbeyourgithub (#2904)+++# Screenshots πΈ+++### Offline Reading++<img width="603" height="1311" alt="Screenshot 2026-08-01 at 7 41 17β―PM" src="https://github.com/user-attachments/assets/15eca558-2fa9-44d2-9c75-c7e6042b44c1" />++++### New Mobile List Layouts++*Please don't judge my saved content*++<img width="603" height="1258" alt="Screenshot 2026-08-01 at 7 38 55β―PM" src="https://github.com/user-attachments/assets/bf5aa418-b80f-4d75-968a-2b99914df803" />+++# 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`.+++## Enabling Embeddings++1. Karakeep's embedding uses your existing meilisearch installation as the default vector store. If you're an OG, and running an old meilisearch version, you'll need to ensure you're on meilisearch version (1.13 or higher). Check [this guide](https://www.meilisearch.com/docs/resources/migration/updating#updating-a-self-hosted-meilisearch-instance) for info on how to update.+2. If you're using the default OpenAI based configuration, auto embeddings of new bookmarks will be enabled automatically and will use the `text-embedding-3-small` model.+3. If you're using a custom provider, you'll need to pass in the `EMBEDDING_TEXT_MODEL=<your_mode>`, the size of the dimension of the model via `EMBEDDING_DIMENSIONS` and then pass `EMBEDDING_ENABLE_AUTO_INDEXING=true` to enable embeddings. Check out [our docs](https://docs.karakeep.app/configuration/different-ai-providers) for example models and configurations.++Once you've enabled embeddings, you'll need to regenerate embeddings for all existing bookmarks. Head to the admin panel's Background Jobs page (new "Embeddings" card) and regenerate embeddings for all/pending bookmarks. This might take a while depending on how many bookmarks you have, and will cost you money (though embeddings are usually pretty cheap).++NOTE: Changing the model or its dimension after embedding even a single bookmark will require you to regenerate embeddings for *all* bookmarks.diff --git a/release-notes/2026-08-11-v0.33.2.md b/release-notes/2026-08-11-v0.33.2.mdnew file mode 100644index 00000000..a0197fea--- /dev/null+++ b/release-notes/2026-08-11-v0.33.2.md@@ -0,0 +1,14 @@+# 0.33.2++This is a patch release for after [0.33.1](https://github.com/karakeep-app/karakeep/releases/tag/v0.33.1). It contains the following fixes:++**Bug fixes:**+* Change default "use max completion tokens" token env variable to `true` when using the default OpenAI configuration now that we're using 5.6 luna and this flag is required there (#3007).+* We're migrating to a custom karakeep chrome container (based on https://github.com/chromedp/docker-headless-shell) now that the old alpine-chrome is no longer fetch-able (and has been long abandoned by the maintainer). Check the migration guide [here](https://docs.karakeep.app/next/administration/chrome-image-migration). The old image will continue to work, but it's recommended that you migrate to the new one as it also upgrades chrome to 151 (compared to 124 in the old image). If you've been using browserless (e.g. on unraid), you're not impacted by this, and you don't need to migrate.+* Large singlefile archives (typically because of videos) used to fail metadata extraction as the parser used to OOM. We strip inline videos now to make the parsing succeed.+* Hardened the link to asset conversion mechanism in the crawler that used to result into silently broken assets. (#3002)+* Pinned nodejs to version 24.18.1 thanks to @eriktews (#2996) to overcome a bug in the latest node 24.19 version (check #2989 for details). The proxmox scripts also were pinned by @MickLesk.+* Karakeep's favicon is now light/dark mode aware, thanks to @ehfreema (#2990).++**New features:**+* You can now upload custom SingleFile archives to karakeep directly using the CLI.