karakeep

Breaking changes

What to check before upgrading, taken from the notes of the last 30 releases.

• v0.33.1Aug 1, 2026
  • ⚠️ Semantic search requires embeddings to be enabled, read the upgrade notes for details about how to enable them.

  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

  • 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 for info on how to update.
  • 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.
  • If you're using a custom provider, you'll need to pass in the EMBEDDING_TEXT_MODEL=, 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 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.

• v0.30.0Jan 1, 2026

  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.

  • fix!: changing default for includeContent to be false in the API - @MohamedBassem in 1369ad01
• v0.28.0Nov 8, 2025
  • ⚠️ (Potentially breaking change) ⚠️ Stricter URL valdaition to protect against SSRF attacks (#2082)

  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.
• v0.24.0Apr 27, 2025
  • ### ⚠️ The firefox extension is back under a new name (Action Required) ⚠️
  • ⚠️ 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.

  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