diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/docs/04-using-karakeep/search-query-language.md (renamed from docs/versioned_docs/version-v0.24.0/14-Guides/02-search-query-language.md) | 25 | ||||
| -rw-r--r-- | docs/versioned_docs/version-v0.24.0/14-Guides/03-singlefile.md | 30 | ||||
| -rw-r--r-- | docs/versioned_docs/version-v0.24.0/14-Guides/04-hoarder-to-karakeep-migration.md | 28 | ||||
| -rw-r--r-- | docs/versioned_docs/version-v0.24.0/14-Guides/05-different-ai-providers.md | 66 | ||||
| -rw-r--r-- | docs/versioned_docs/version-v0.30.0/06-administration/07-legacy-container-upgrade.md (renamed from docs/versioned_docs/version-v0.24.0/14-Guides/01-legacy-container-upgrade.md) | 0 |
5 files changed, 21 insertions, 128 deletions
diff --git a/docs/versioned_docs/version-v0.24.0/14-Guides/02-search-query-language.md b/docs/docs/04-using-karakeep/search-query-language.md index be9739b4..cdf1f56e 100644 --- a/docs/versioned_docs/version-v0.24.0/14-Guides/02-search-query-language.md +++ b/docs/docs/04-using-karakeep/search-query-language.md @@ -1,3 +1,8 @@ +--- +sidebar_position: 9 +slug: search-query-language +--- + # Search Query Language Karakeep provides a search query language to filter and find bookmarks. Here are all the supported qualifiers and how to use them: @@ -6,8 +11,8 @@ Karakeep provides a search query language to filter and find bookmarks. Here are - Use spaces to separate multiple conditions (implicit AND) - Use `and`/`or` keywords for explicit boolean logic -- Use parentheses `()` for grouping conditions -- Prefix qualifiers with `-` to negate them +- Prefix qualifiers with `-` or `!` to negate them (e.g., `-is:archived` or `!is:archived`) +- Use parentheses `()` for grouping conditions (note that groups can't be negated) ## Qualifiers @@ -20,14 +25,18 @@ Here's a comprehensive table of all supported qualifiers: | `is:tagged` | Bookmarks that has one or more tags | `is:tagged` | | `is:inlist` | Bookmarks that are in one or more lists | `is:inlist` | | `is:link`, `is:text`, `is:media` | Bookmarks that are of type link, text or media | `is:link` | +| `is:broken` | Bookmarks with broken/failed links (crawl failures or non-2xx status codes) | `is:broken` | | `url:<value>` | Match bookmarks with URL substring | `url:example.com` | -| `#<tag>` | Match bookmarks with specific tag | `#important` | -| | Supports quoted strings for tags with spaces | `#"work in progress"` | +| `title:<value>` | Match bookmarks with title substring | `title:example` | +| | Supports quoted strings for titles with spaces | `title:"my title"` | +| `#<tag>` or `tag:<tag>` | Match bookmarks with specific tag | `#important` or `tag:important` | +| | Supports quoted strings for tags with spaces | `#"work in progress"` or `tag:"work in progress"` | | `list:<name>` | Match bookmarks in specific list | `list:reading` | | | Supports quoted strings for list names with spaces | `list:"to review"` | | `after:<date>` | Bookmarks created on or after date (YYYY-MM-DD) | `after:2023-01-01` | | `before:<date>` | Bookmarks created on or before date (YYYY-MM-DD) | `before:2023-12-31` | | `feed:<name>` | Bookmarks imported from a particular rss feed | `feed:Hackernews` | +| `source:<value>` | Match bookmarks from a specific source. Valid values: `api`, `web`, `cli`, `mobile`, `extension`, `singlefile`, `rss`, `import` | `source:rss` `-source:web` | | `age:<time-range>` | Match bookmarks based on how long ago they were created. Use `<` or `>` to indicate the maximum / minimum age of the bookmarks. Supported units: `d` (days), `w` (weeks), `m` (months), `y` (years). | `age:<1d` `age:>2w` `age:<6m` `age:>3y` | ### Examples @@ -41,6 +50,8 @@ is:archived and (list:reading or #work) # Find bookmarks that are not tagged or not in any list -is:tagged or -is:inlist +# Find bookmarks with "React" in the title +title:React ``` ## Combining Conditions @@ -56,6 +67,12 @@ is:archived and (list:reading or #work) # Find bookmarks that are not favorited and not archived -is:fav -is:archived + +# Using ! as an alias for negation +!is:fav !is:archived + +# Using tag: as an alias for # +tag:important tag:"work in progress" ``` ## Text Search diff --git a/docs/versioned_docs/version-v0.24.0/14-Guides/03-singlefile.md b/docs/versioned_docs/version-v0.24.0/14-Guides/03-singlefile.md deleted file mode 100644 index bc4acb64..00000000 --- a/docs/versioned_docs/version-v0.24.0/14-Guides/03-singlefile.md +++ /dev/null @@ -1,30 +0,0 @@ -# Using Karakeep with SingleFile Extension - -Karakeep supports being a destination for the [SingleFile extension](https://github.com/gildas-lormeau/SingleFile). This has the benefit of allowing you to use the singlefile extension to hoard links as you're seeing them in the browser. This is perfect for websites that don't like to get crawled, has annoying cookie banner or require authentication. - -## Setup - -1. Install the [SingleFile extension](https://github.com/gildas-lormeau/SingleFile). -2. In the extension settings, select `Destinations`. -3. Select `upload to a REST Form API`. -4. In the URL, insert the address: `https://YOUR_SERVER_ADDRESS/api/v1/bookmarks/singlefile`. -5. In the `authorization token` field, paste an API key that you can get from your karakeep settings. -6. Set `data field name` to `file`. -7. Set `URL field name` to `url`. - -Now, go to any page and click the singlefile extension icon. Once it's done with the upload, the bookmark should show up in your karakeep instance. Note that the singlefile extension doesn't show any progress on the upload. Given that archives are typically large, it might take 30+ seconds until the upload is done and starts showing up in Karakeep. - - -## Recommended settings - -In the singlefile extension, you probably will want to change the following settings for better experience: -* Stylesheets > compress CSS content: on -* Stylesheets > group duplicate stylesheets together: on -* HTML content > remove frames: on - -Also, you most likely will want to change the default `MAX_ASSET_SIZE_MB` in karakeep to something higher, for example `100`. - -:::info -Currently, we don't support screenshots for singlefile uploads, but this will change in the future. -::: - diff --git a/docs/versioned_docs/version-v0.24.0/14-Guides/04-hoarder-to-karakeep-migration.md b/docs/versioned_docs/version-v0.24.0/14-Guides/04-hoarder-to-karakeep-migration.md deleted file mode 100644 index 289a091c..00000000 --- a/docs/versioned_docs/version-v0.24.0/14-Guides/04-hoarder-to-karakeep-migration.md +++ /dev/null @@ -1,28 +0,0 @@ -# Hoarder to Karakeep Migration - -Hoarder is rebranding to Karakeep. Due to github limitations, the old docker image might not be getting new updates after the rebranding. You might need to update your docker image to point to the new karakeep image instead by applying the following change in the docker compose file. - -```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:${HOARDER_VERSION:-release} -+ image: ghcr.io/karakeep-app/karakeep:${HOARDER_VERSION:-release} -``` - -You can also change the `HOARDER_VERSION` environment variable but if you do so remember to change it in the `.env` file as well. - -## Migrating a Baremetal Installation - -If you previously used the [Debian/Ubuntu install script](https://docs.karakeep.app/Installation/debuntu) to install Hoarder, there is an option to migrate your installation to Karakeep. - -```bash -bash karakeep-linux.sh migrate -``` - -This will migrate your installation with no user input required. After the migration, the script will also check for an update. diff --git a/docs/versioned_docs/version-v0.24.0/14-Guides/05-different-ai-providers.md b/docs/versioned_docs/version-v0.24.0/14-Guides/05-different-ai-providers.md deleted file mode 100644 index 33408c00..00000000 --- a/docs/versioned_docs/version-v0.24.0/14-Guides/05-different-ai-providers.md +++ /dev/null @@ -1,66 +0,0 @@ -# Configuring different AI Providers - -Karakeep uses LLM providers for AI tagging and summarization. We support OpenAI-compatible providers and ollama. This guide will show you how to configure different providers. - -## OpenAI - -If you want to use OpenAI itself, you just need to pass in the OPENAI_API_KEY environment variable. - -``` -OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - -# You can change the default models by uncommenting the following lines, and choosing your model. -# INFERENCE_TEXT_MODEL=gpt-4.1-mini -# INFERENCE_IMAGE_MODEL=gpt-4o-mini -``` - -## Ollama - -Ollama is a local LLM provider that you can use to run your own LLM server. You'll need to pass ollama's address to karakeep and you need to ensure that it's accessible from within the karakeep container (e.g. no localhost addresses). - -``` -# MAKE SURE YOU DON'T HAVE OPENAI_API_KEY set, otherwise it takes precedence. - -OLLAMA_BASE_URL=http://ollama.mylab.com:11434 - -# Make sure to pull the models in ollama first. Example models: -INFERENCE_TEXT_MODEL=gemma3 -INFERENCE_IMAGE_MODEL=llava - -# If the model you're using doesn't support structured output, you also need: -# INFERENCE_OUTPUT_SCHEMA=plain -``` - -## Gemini - -Gemini has an OpenAI-compatible API. You need to get an api key from Google AI Studio. - -``` - -OPENAI_BASE_URL=https://generativelanguage.googleapis.com/v1beta -OPENAI_API_KEY=YOUR_API_KEY - -# Example models: -INFERENCE_TEXT_MODEL=gemini-2.0-flash -INFERENCE_IMAGE_MODEL=gemini-2.0-flash -``` - -## OpenRouter - -``` -OPENAI_BASE_URL=https://openrouter.ai/api/v1 -OPENAI_API_KEY=YOUR_API_KEY - -# Example models: -INFERENCE_TEXT_MODEL=meta-llama/llama-4-scout -INFERENCE_IMAGE_MODEL=meta-llama/llama-4-scout -``` - -## Perplexity - -``` -OPENAI_BASE_URL: https://api.perplexity.ai -OPENAI_API_KEY: Your Perplexity API Key -INFERENCE_TEXT_MODEL: sonar-pro -INFERENCE_IMAGE_MODEL: sonar-pro -``` diff --git a/docs/versioned_docs/version-v0.24.0/14-Guides/01-legacy-container-upgrade.md b/docs/versioned_docs/version-v0.30.0/06-administration/07-legacy-container-upgrade.md index d95c1c1e..d95c1c1e 100644 --- a/docs/versioned_docs/version-v0.24.0/14-Guides/01-legacy-container-upgrade.md +++ b/docs/versioned_docs/version-v0.30.0/06-administration/07-legacy-container-upgrade.md |