aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-01-05 16:45:17 +0000
committerMohamed Bassem <me@mbassem.com>2025-01-05 16:45:17 +0000
commit43e01d55d8fee2f2d517dd9f5e8adb2c143333dd (patch)
treedede3d2e2b637d3f5baf45cd4ed88399996cff96 /docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md
parent12cb8c5c284e766992e2154de185f6e1062fe045 (diff)
downloadkarakeep-43e01d55d8fee2f2d517dd9f5e8adb2c143333dd.tar.zst
docs: Release the 0.21 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md')
-rw-r--r--docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md b/docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md
new file mode 100644
index 00000000..147c1621
--- /dev/null
+++ b/docs/versioned_docs/version-v0.21.0/02-Installation/07-minimal-install.md
@@ -0,0 +1,49 @@
+# Minimal Installation
+
+:::warning
+Unless necessary, prefer the [full installation](/Installation/docker) to leverage all the features of hoarder. You'll be sacrificing a lot of functionality if you go with the minimal installation route.
+:::
+
+Hoarder's default installation has a dependency on Meilisearch for the full text search, Chrome for crawling and OpenAI/Ollama for AI tagging. You can however run hoarder without those dependencies if you're willing to sacrifice those features.
+
+- If you run without meilisearch, the search functionality will be completely disabled.
+- If you run without chrome, crawling will still work, but you'll lose ability to take screenshots of websites and websites with javascript content won't get crawled correctly.
+- If you don't setup OpenAI/Ollama, AI tagging will be disabled.
+
+Those features are important for leveraging hoarder's full potential, but if you're running in constrained environments, you can use the following minimal docker compose to skip all those dependencies:
+
+```yaml
+services:
+ web:
+ image: ghcr.io/hoarder-app/hoarder:release
+ restart: unless-stopped
+ volumes:
+ - data:/data
+ ports:
+ - 3000:3000
+ environment:
+ DATA_DIR: /data
+ NEXTAUTH_SECRET: super_random_string
+volumes:
+ data:
+```
+
+Or just with the following docker command:
+
+```base
+docker run -d \
+ --restart unless-stopped \
+ -v data:/data \
+ -p 3000:3000 \
+ -e DATA_DIR=/data \
+ -e NEXTAUTH_SECRET=super_random_string \
+ ghcr.io/hoarder-app/hoarder:release
+```
+
+:::warning
+You **MUST** change the `super_random_string` to a true random string which you can generate with `openssl rand -hex 32`.
+:::
+
+Check the [configuration docs](/configuration) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
+
+