A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search
docs: explain Browserless Playwright version compatibility (#3214)
monsterlagb619d11f82d1
diff --git a/docs/docs/06-administration/05-troubleshooting.md b/docs/docs/06-administration/05-troubleshooting.mdindex 3498a66d..2517bd6a 100644--- a/docs/docs/06-administration/05-troubleshooting.md+++ b/docs/docs/06-administration/05-troubleshooting.md@@ -32,6 +32,14 @@ Check the logs of the container and this will usually tell you what's wrong. ComCheck 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.+### Browserless compatibility++Connections to Browserless through `BROWSER_WEBSOCKET_URL` use the Playwright protocol. The server must support the same Playwright major/minor version as Karakeep's bundled client.++Karakeep 0.34.0 bundles Patchright 1.59.4 (a Playwright fork), but Browserless v2.57.1 no longer includes a Playwright 1.59 server. As reported in [#3207](https://github.com/karakeep-app/karakeep/issues/3207), this mismatch can leave every crawl stuck after `Successfully navigated to "…". Waiting for the page to load ...` until `CRAWLER_JOB_TIMEOUT_SEC` expires (60 seconds by default), even though the browser connection succeeds. The reporter's working comparison was Browserless v2.57.0, which still includes Playwright 1.59 support.++Prefer [migrating to the Karakeep Chrome image](09-chrome-image-migration.md). Set `BROWSER_WEB_URL=http://chrome:9222` (adjust the hostname for your setup) and remove `BROWSER_WEBSOCKET_URL`. If you continue using Browserless, choose a release that supports your Karakeep client's Playwright major/minor version.+## Upgrading Meilisearch - Migrating the Meilisearch db version[Meilisearch](https://www.meilisearch.com/) is the database used by karakeep for searching in your bookmarks. Karakeep is tested with the Meilisearch version pinned in the bundled docker compose file, so prefer that version unless you have a reason to change it. After changing the Meilisearch version, you might see errors like `Your database version (x.x.x) is incompatible with your current engine version (x.x.x)`.diff --git a/docs/versioned_docs/version-v0.34.0/06-administration/05-troubleshooting.md b/docs/versioned_docs/version-v0.34.0/06-administration/05-troubleshooting.mdindex 2b03f328..2daf707c 100644--- a/docs/versioned_docs/version-v0.34.0/06-administration/05-troubleshooting.md+++ b/docs/versioned_docs/version-v0.34.0/06-administration/05-troubleshooting.md@@ -32,6 +32,14 @@ Check the logs of the container and this will usually tell you what's wrong. ComCheck 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.+### Browserless compatibility++Connections to Browserless through `BROWSER_WEBSOCKET_URL` use the Playwright protocol. The server must support the same Playwright major/minor version as Karakeep's bundled client.++Karakeep 0.34.0 bundles Patchright 1.59.4 (a Playwright fork), but Browserless v2.57.1 no longer includes a Playwright 1.59 server. As reported in [#3207](https://github.com/karakeep-app/karakeep/issues/3207), this mismatch can leave every crawl stuck after `Successfully navigated to "…". Waiting for the page to load ...` until `CRAWLER_JOB_TIMEOUT_SEC` expires (60 seconds by default), even though the browser connection succeeds. The reporter's working comparison was Browserless v2.57.0, which still includes Playwright 1.59 support.++Prefer [migrating to the Karakeep Chrome image](09-chrome-image-migration.md). Set `BROWSER_WEB_URL=http://chrome:9222` (adjust the hostname for your setup) and remove `BROWSER_WEBSOCKET_URL`. If you continue using Browserless, choose a release that supports your Karakeep client's Playwright major/minor version.+## 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.41.0` and it is advised not to upgrade it without good reasons. If you do, you might see errors like `Your database version (x.x.x) is incompatible with your current engine version (x.x.x). To migrate data between Meilisearch versions, please follow our guide on https://www.meilisearch.com/docs/learn/update_and_migration/updating.`.