docs: Release the 0.23.1 docs

4 files changed, 183 insertions, 0 deletions

diff --git a/docs/versioned_docs/version-v0.23.1/14-Guides/01-legacy-container-upgrade.md b/docs/versioned_docs/version-v0.23.1/14-Guides/01-legacy-container-upgrade.md
new file mode 100644
index 00000000..3c86705a
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.1/14-Guides/01-legacy-container-upgrade.md
@@ -0,0 +1,66 @@
+# Legacy Container Upgrade
+
+Hoarder's 0.16 release consolidated the web and worker containers into a single container and also dropped the need for the redis container. The legacy containers will stop being supported soon, to upgrade to the new container 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`.
+
+```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:
+```
diff --git a/docs/versioned_docs/version-v0.23.1/14-Guides/02-search-query-language.md b/docs/versioned_docs/version-v0.23.1/14-Guides/02-search-query-language.md
new file mode 100644
index 00000000..b0d8ffd3
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.1/14-Guides/02-search-query-language.md
@@ -0,0 +1,69 @@
+# Search Query Language
+
+Hoarder provides a search query language to filter and find bookmarks. Here are all the supported qualifiers and how to use them:
+
+## Basic Syntax
+
+- 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
+
+## Qualifiers
+
+Here's a comprehensive table of all supported qualifiers:
+
+| Qualifier                        | Description                                        | Example Usage         |
+| -------------------------------- | -------------------------------------------------- | --------------------- |
+| `is:fav`                         | Favorited bookmarks                                | `is:fav`              |
+| `is:archived`                    | Archived bookmarks                                 | `-is:archived`        |
+| `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`             |
+| `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"` |
+| `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 orbefore date (YYYY-MM-DD)    | `before:2023-12-31`   |
+
+### Examples
+
+```plaintext
+# Find favorited bookmarks from 2023 that are tagged "important"
+is:fav after:2023-01-01 before:2023-12-31 #important
+
+# Find archived bookmarks that are either in "reading" list or tagged "work"
+is:archived and (list:reading or #work)
+
+# Find bookmarks that are not tagged or not in any list
+-is:tagged or -is:inlist
+```
+
+## Combining Conditions
+
+You can combine multiple conditions using boolean logic:
+
+```plaintext
+# Find favorited bookmarks from 2023 that are tagged "important"
+is:fav after:2023-01-01 before:2023-12-31 #important
+
+# Find archived bookmarks that are either in "reading" list or tagged "work"
+is:archived and (list:reading or #work)
+
+# Find bookmarks that are not favorited and not archived
+-is:fav -is:archived
+```
+
+## Text Search
+
+Any text not part of a qualifier will be treated as a full-text search:
+
+```plaintext
+# Search for "machine learning" in bookmark content
+machine learning
+
+# Combine text search with qualifiers
+machine learning is:fav
+```
diff --git a/docs/versioned_docs/version-v0.23.1/14-Guides/03-singlefile.md b/docs/versioned_docs/version-v0.23.1/14-Guides/03-singlefile.md
new file mode 100644
index 00000000..522caf50
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.1/14-Guides/03-singlefile.md
@@ -0,0 +1,30 @@
+# Using Hoarder with SingleFile Extension
+
+Hoarder 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 hoarder 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 hoarder 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 Hoarder.
+
+
+## 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 hoarder 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.23.1/14-Guides/04-hoarder-to-karakeep-migration.md b/docs/versioned_docs/version-v0.23.1/14-Guides/04-hoarder-to-karakeep-migration.md
new file mode 100644
index 00000000..1ac50c7c
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.1/14-Guides/04-hoarder-to-karakeep-migration.md
@@ -0,0 +1,18 @@
+# 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.