diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-29 18:31:05 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-11-29 18:32:19 +0000 |
| commit | 97c386a4d15294b4ed07ff83c8a6a773e7289ab8 (patch) | |
| tree | 3c8a22fdd92efa489638d5216714497d61b47b3e /docs/versioned_docs/version-v0.29.0/02-installation/07-minimal-install.md | |
| parent | f01d96fd91f8829d4d91c465e9950e78fc6f7513 (diff) | |
| download | karakeep-97c386a4d15294b4ed07ff83c8a6a773e7289ab8.tar.zst | |
release(docs): release the 0.29 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/02-installation/07-minimal-install.md')
| -rw-r--r-- | docs/versioned_docs/version-v0.29.0/02-installation/07-minimal-install.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/02-installation/07-minimal-install.md b/docs/versioned_docs/version-v0.29.0/02-installation/07-minimal-install.md new file mode 100644 index 00000000..5c2ee399 --- /dev/null +++ b/docs/versioned_docs/version-v0.29.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 Karakeep. You'll be sacrificing a lot of functionality if you go with the minimal installation route. +::: + +Karakeep'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 Karakeep 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 Karakeep'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/karakeep-app/karakeep: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/karakeep-app/karakeep: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. + + |
