Home assistant add-on: Karakeep
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, Home Assistant changes, and testing on real hardware takes a lot of time (and some money). I use around 5–10 of my >110 addons so regularly I install test machines (and purchase some test services such as VPNs) that I do not use myself, in order to troubleshoot and improve the addons.
If this add-on saves you time or makes your setup easier, I would be very grateful for your support.
Addon informations
Thanks to everyone who has starred my repo!
About
Karakeep is a bookmark-everything app with a touch of AI for data hoarders.
It stores pages, screenshots, files, and metadata with fast full-text and semantic search powered by Meilisearch.
This add-on is based on the official Karakeep Docker image.
This Home Assistant add-on integrates Karakeep in a Supervisor-native way:
- Internal services (Meilisearch, Chromium, cache, paths) are pre-wired and hidden from the UI
- Secrets are auto-generated and persisted
- Only meaningful user settings are exposed
Add additional environment variables with env_vars
Secrets & Security
Two secrets are required for Karakeep to work securely:
NEXTAUTH_SECRETMEILI_MASTER_KEY
If you leave them empty, the add-on will:
- Generate strong cryptographic secrets automatically
- Store them permanently in the add-on options
- Reuse them across restarts and upgrades
You do not need to manage them manually.
Configuration
Only safe, meaningful options are exposed.
All infrastructure (Meilisearch, Chromium, cache, paths, analytics, etc.) is managed automatically by the add-on.
Options
| Option | Type | Default | Description |
|---|---|---|---|
NEXTAUTH_SECRET |
password | (auto) | Authentication secret (auto-generated if empty). |
NEXTAUTH_URL |
str | Public URL used by NextAuth (optional). | |
DISABLE_SIGNUPS |
bool | false |
Disable new user signups. |
MAX_ASSET_SIZE_MB |
int | 4 |
Maximum asset upload size. |
OPENAI_API_KEY |
password | OpenAI API key for AI features. | |
OCR_LANGS |
str | OCR languages (comma separated). | |
INFERENCE_LANG |
str | Language used for AI inference. | |
CRAWLER_DOWNLOAD_BANNER_IMAGE |
bool | true |
Download banner image. |
CRAWLER_STORE_SCREENSHOT |
bool | true |
Store page screenshots. |
CRAWLER_FULL_PAGE_SCREENSHOT |
bool | true |
Capture full-page screenshots. |
CRAWLER_FULL_PAGE_ARCHIVE |
bool | true |
Store full-page archive. |
CRAWLER_ENABLE_ADBLOCKER |
bool | true |
Enable ad blocking. |
CRAWLER_VIDEO_DOWNLOAD |
bool | false |
Enable video downloads. |
TZ |
str | Etc/UTC |
Timezone. |
Installation
-
Install Karakeep
-
Click Save
-
Start the add-on (secrets are auto-generated)
-
Open the Web UI and complete onboarding
Support
Create an issue on GitHub if you need help.