avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-13 11:21:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Revise README for clarity and organization

Browse Source 
Updated the README to streamline information and improve clarity. Adjusted sections on secrets, configuration options, and installation steps.
This commit is contained in:
Alexandre
2026-01-11 17:07:11 +01:00
committed by GitHub
parent 25034e2e47
commit aef148d8cd
1 changed files with 35 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
karakeep/README.md
View File

@@ -1,103 +1,63 @@
# Home assistant add-on: Karakeep
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA 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 vpn) that I don't use myself 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!
## Secrets & Security
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
Two secrets are required for Karakeep to work securely:
## Addon informations
- `NEXTAUTH_SECRET`
- `MEILI_MASTER_KEY`
![Version](https://img.shields.io/badge/dynamic/yaml?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fkarakeep%2Fconfig.yaml)
![Ingress](https://img.shields.io/badge/dynamic/yaml?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fkarakeep%2Fconfig.yaml)
![Arch](https://img.shields.io/badge/dynamic/yaml?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fkarakeep%2Fconfig.yaml)
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
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
[![Builder](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/onpush_builder.yaml?label=Builder)](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
You do **not** need to manage them manually.
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers)
## About
[Karakeep](https://karakeep.app/) is a bookmark-everything app with a touch of AI for the data hoarders out there. It stores content, screenshots, and metadata with search powered by Meilisearch.
This addon is based on the [official Karakeep Docker image](https://github.com/karakeep-app/karakeep).
---
## Configuration
Webui can be found at `<your-ip>:3000`.
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 | | Secret key for authentication (auto-generated if left blank). |
| `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 account signups. |
| `MAX_ASSET_SIZE_MB` | int | `4` | Max asset upload size. |
| `OCR_LANGS` | str | | OCR language codes (comma-separated). |
| `OCR_CONFIDENCE_THRESHOLD` | int | | OCR confidence threshold (0-100). |
| `OPENAI_BASE_URL` | str | | Custom OpenAI base URL. |
| `OPENAI_API_KEY` | password | | OpenAI API key. |
| `OLLAMA_BASE_URL` | str | | Ollama base URL. |
| `INFERENCE_TEXT_MODEL` | str | | Text inference model name. |
| `INFERENCE_IMAGE_MODEL` | str | | Image inference model name. |
| `EMBEDDING_TEXT_MODEL` | str | | Embedding model name. |
| `INFERENCE_CONTEXT_LENGTH` | int | | Inference context length. |
| `INFERENCE_LANG` | str | | Language used for inference. |
| `INFERENCE_JOB_TIMEOUT_SEC` | int | | Timeout for inference jobs. |
| `CRAWLER_DOWNLOAD_BANNER_IMAGE` | bool | `true` | Download banner image during crawl. |
| `CRAWLER_STORE_SCREENSHOT` | bool | `false` | Store screenshot during crawl. |
| `CRAWLER_FULL_PAGE_SCREENSHOT` | bool | `false` | Capture full-page screenshots. |
| `CRAWLER_FULL_PAGE_ARCHIVE` | bool | `false` | Store full-page archive. |
| `CRAWLER_JOB_TIMEOUT_SEC` | int | | Crawler job timeout. |
| `CRAWLER_NAVIGATE_TIMEOUT_SEC` | int | | Navigation timeout. |
| `CRAWLER_VIDEO_DOWNLOAD` | bool | | Enable video downloads. |
| `CRAWLER_VIDEO_DOWNLOAD_MAX_SIZE` | int | | Max video size (MB). |
| `CRAWLER_VIDEO_DOWNLOAD_TIMEOUT_SEC` | int | | Video download timeout. |
| `CRAWLER_ENABLE_ADBLOCKER` | bool | `true` | Enable ad blocking in the crawler. |
| `CHROME_EXTENSIONS_DIR` | str | `/usr/src/chrome/extensions` | Extensions directory for headless Chromium. |
| `MEILI_MASTER_KEY` | password | | Meilisearch master key (auto-generated if left blank). |
| `MEILI_ADDR` | str | | Meilisearch URL. |
| `BROWSER_WEB_URL` | str | | Chromium remote debugging URL. |
| `DATA_DIR` | str | | Data directory (leave default). |
| `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. |
### Extensions for headless Chromium
This add-on loads extensions in headless Chromium with the `--headless=new` flag. The defaults are downloaded automatically during the image build and refreshed each time the add-on starts into `/usr/src/chrome/extensions` (non-persistent).
You can override the base folder with the `CHROME_EXTENSIONS_DIR` option to point to a host-mounted directory if you prefer to manage extensions manually. Any missing extension folder is skipped at runtime.
### Custom Scripts and Environment Variables
This addon supports custom scripts and environment variables through the `addon_config` mapping:
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **env_vars option**: Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
---
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. Add my Home Assistant add-ons repository
[![Add repository][repository-badge]][repository-url]
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. [![Add repository on my Home Assistant][repository-badge]][repository-url]
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on (secrets are auto-generated if left blank).
1. Check the logs of the add-on to see if everything went well.
1. Open the webUI and complete the onboarding.
2. Install **Karakeep**
3. Click **Save**
4. Start the add-on (secrets are auto-generated)
5. Open the Web UI and complete onboarding
---
## Support
Create an issue on GitHub if you need support.
Create an issue on GitHub if you need help.
[repository]: https://github.com/alexbelgium/hassio-addons
[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge