aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/12-community-projects.md24
-rw-r--r--docs/docs/13-Guides/01-legacy-container-upgrade.md66
2 files changed, 90 insertions, 0 deletions
diff --git a/docs/docs/12-community-projects.md b/docs/docs/12-community-projects.md
new file mode 100644
index 00000000..b6a65f67
--- /dev/null
+++ b/docs/docs/12-community-projects.md
@@ -0,0 +1,24 @@
+# Community Projects
+
+This page lists community projects that are built around Hoarder, but not officially supported by the development team.
+
+:::warning
+This list comes with no guarantees about security, performance, reliability, or accuracy. Use at your own risk.
+:::
+
+
+### Raycast Extension
+
+*By [@luolei](https://github.com/foru17).*
+
+A user-friendly Raycast extension that seamlessly integrates with Hoarder, bringing powerful bookmark management to your fingertips. Quickly save, search, and organize your bookmarks, texts, and images—all through Raycast's intuitive interface.
+
+Get it [here](https://www.raycast.com/luolei/hoarder).
+
+### Alfred Workflow
+
+*By [@yinan-c](https://github.com/yinan-c)*
+
+An Alfred workflow to quickly hoard stuff or access your hoarded bookmarks!
+
+Get it [here](https://www.alfredforum.com/topic/22528-hoarder-workflow-for-self-hosted-bookmark-management/).
diff --git a/docs/docs/13-Guides/01-legacy-container-upgrade.md b/docs/docs/13-Guides/01-legacy-container-upgrade.md
new file mode 100644
index 00000000..3c86705a
--- /dev/null
+++ b/docs/docs/13-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:
+```