aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2024-05-18 13:32:12 +0100
committerMohamedBassem <me@mbassem.com>2024-05-18 13:32:12 +0100
commiteb218cefbf82f460e3830d66d7f0d0ca63d1ac6d (patch)
treedd5d570e5861c4506f3f27b03ce1fabf72d332fe
parentc9dc23f43e0d87453b74105a8ffc81ce9f4bd98a (diff)
downloadkarakeep-eb218cefbf82f460e3830d66d7f0d0ca63d1ac6d.tar.zst
docs: Add documentation for installing hoarder on unraid. Fixes #81
-rw-r--r--README.md2
-rw-r--r--docs/docs/02-Installation/01-docker.md (renamed from docs/docs/02-installation.md)4
-rw-r--r--docs/docs/02-Installation/02-unraid.md21
3 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index 59931eaa..b4032814 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ A self-hostable bookmark-everything app with a touch of AI for the data hoarders
## Documentation
-- [Installation](https://docs.hoarder.app/installation)
+- [Installation](https://docs.hoarder.app/installation/docker)
- [Configuration](https://docs.hoarder.app/configuration)
- [Screenshots](https://docs.hoarder.app/screenshots)
- [Security Considerations](https://docs.hoarder.app/security-considerations)
diff --git a/docs/docs/02-installation.md b/docs/docs/02-Installation/01-docker.md
index 7e10b7b6..0fa47ad4 100644
--- a/docs/docs/02-installation.md
+++ b/docs/docs/02-Installation/01-docker.md
@@ -1,6 +1,4 @@
-# Installation
-
-## Docker (Recommended)
+# Docker Compose [Recommended]
### Requirements
diff --git a/docs/docs/02-Installation/02-unraid.md b/docs/docs/02-Installation/02-unraid.md
new file mode 100644
index 00000000..1502e125
--- /dev/null
+++ b/docs/docs/02-Installation/02-unraid.md
@@ -0,0 +1,21 @@
+# Unraid
+
+## Docker Compose Manager Plugin (Recommended)
+
+You can use [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin to deploy Hoarder using the official docker compose file provided [here](https://github.com/MohamedBassem/hoarder-app/blob/main/docker/docker-compose.yml). After creating the stack, you'll need to setup some env variables similar to that from the docker compose installation docs [here](/Installation/docker#3-populate-the-environment-variables).
+
+## Community Apps
+
+:::info
+The community application template is maintained by the community.
+:::
+
+Hoarder can be installed on Unraid using the community application plugins. Hoarder is a multi-container service, and because unraid doesn't natively support that, you'll have to install the different pieces as separate applications and wire them manually together.
+
+Here's a high level overview of the services you'll need:
+
+- **Hoarder** ([Support post](https://forums.unraid.net/topic/165108-support-collectathon-hoarder/)): Hoarder's main web app.
+- **hoarder-worker** ([Support post](https://forums.unraid.net/topic/165108-support-collectathon-hoarder/)): Hoarder's background workers (for running the AI tagging, fetching the content, etc).
+- **Redis**: Currently used for communication between the web app and the background workers.
+- **Browserless** ([Support post](https://forums.unraid.net/topic/130163-support-template-masterwishxbrowserless/)): The chrome headless service used for fetching the content. Hoarder's official docker compose doesn't use browserless, but it's currently the only headless chrome service available on unraid, so you'll have to use it.
+- **MeiliSearch** ([Support post](https://forums.unraid.net/topic/164847-support-collectathon-meilisearch/)): The search engine used by Hoarder. It's optional but highly recommended. If you don't have it set up, search will be disabled.