aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOlicorne <26625900+thiswillbeyourgithub@users.noreply.github.com>2025-05-18 17:21:13 +0200
committerGitHub <noreply@github.com>2025-05-18 16:21:13 +0100
commit74e74fa6425f072107de3a9bc9dd8f91c5ac9a7d (patch)
tree0a15a7014730f8895862338ddcca35508cd8535f
parent3a59293171a95130bb27fe89f8403a7adf50496e (diff)
downloadkarakeep-74e74fa6425f072107de3a9bc9dd8f91c5ac9a7d.tar.zst
doc: document how to upgrade meilisearch / migrate meilisearch db (#1436)
* doc: document how to upgrade meilisearch / migrate meilisearch db * add link to official meilisearch doc
-rw-r--r--docs/docs/12-troubleshooting.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/docs/12-troubleshooting.md b/docs/docs/12-troubleshooting.md
index 7b086440..4072442b 100644
--- a/docs/docs/12-troubleshooting.md
+++ b/docs/docs/12-troubleshooting.md
@@ -31,3 +31,16 @@ Check the logs of the container and this will usually tell you what's wrong. Com
Check the logs of the container and this will usually tell you what's wrong. Common problems are:
1. You changed the name of the chrome container but didn't change the `BROWSER_WEB_URL` env variable.
+
+## Upgrading Meilisearch - Migrating the Meilisearch db version
+
+[Meilisearch](https://www.meilisearch.com/) is the database used by karakeep for searching in your bookmarks. The version used by karakeep is `1.13.3` and it is advised not to upgrade it without good reasons. If you do, you might see errors like `Your database version (1.11.1) is incompatible with your current engine version (1.13.3). To migrate data between Meilisearch versions, please follow our guide on https://www.meilisearch.com/docs/learn/update_and_migration/updating.`.
+
+Luckily we can easily workaround this:
+1. Stop the Meilisearch container.
+2. Inside the Meilisearch volume bound to `/meili_data`, erase/rename the folder called `data.ms`.
+3. Launch Meilisearch again.
+4. Login to karakeep as administrator and go to (as of v0.24.1) `Admin Settings > Background Jobs` then click on `Reindex All Bookmarks`.
+5. When the reindexing has finished, Meilisearch should be working as usual.
+
+If you run into issues, the official documentation can be found [there](https://www.meilisearch.com/docs/learn/update_and_migration/updating).