This commit is contained in:
Alexandre
2026-01-12 13:22:35 +01:00
committed by GitHub
parent cf1d00f6f0
commit ee5b9cad34
22 changed files with 0 additions and 586 deletions

View File

@@ -1,11 +0,0 @@
## 1.8.5 (2026-01-12)
- Update to latest version from karakeep-app/karakeep (changelog : https://github.com/karakeep-app/karakeep/releases)
## 0.30.0-4 (11-01-2026)
- Minor bugs fixed
## 0.30.0-3 (11-01-2026)
- Minor bugs fixed
## 0.30.0-2 (11-01-2026)
- Minor bugs fixed
## 0.30.0 (2026-01-11)
- Initial add-on release

View File

@@ -1,194 +0,0 @@
#============================#
# ALEXBELGIUM'S DOCKERFILE #
#============================#
# _.------.
# _.-` ('>.-`"""-.
# '.--'` _'` _ .--.)
# -' '-.-';` `
# ' - _.' ``'--.
# '---` .-'""`
# /`
#=== Home Assistant Addon ===#
#################
# 1 Build Image #
#################
ARG BUILD_FROM
ARG BUILD_VERSION
ARG MEILI_VERSION="v1.13.3"
FROM getmeili/meilisearch:${MEILI_VERSION} AS meilisearch
FROM ${BUILD_FROM}
##################
# 2 Modify Image #
##################
# Set S6 wait time
ENV S6_CMD_WAIT_FOR_SERVICES=1 \
S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0 \
S6_SERVICES_GRACETIME=0
ENV \
DATA_DIR="/data" \
MEILI_DIR="/config/meili" \
DISABLE_NEW_RELEASE_CHECK=true \
BROWSER_WEB_URL="http://127.0.0.1:9222" \
MEILI_ADDR="http://127.0.0.1:7700" \
MEILI_MASTER_KEY="" \
MEILI_NO_ANALYTICS=true \
XDG_CACHE_HOME="/data/cache"
ENV \
CHROME_BIN=/usr/bin/chromium-browser \
CHROME_PATH=/usr/lib/chromium/ \
CHROMIUM_FLAGS="--disable-software-rasterizer --disable-dev-shm-usage" \
MEILI_HTTP_ADDR=0.0.0.0:7700 \
MEILI_SERVER_PROVIDER=docker \
MEILI_ENV=production
# Image specific modifications
RUN \
apk upgrade --no-cache --available \
&& apk add --no-cache \
chromium \
chromium-swiftshader \
ttf-freefont \
font-noto-emoji \
font-wqy-zenhei \
unzip \
&& mkdir -p /usr/src/chrome \
&& adduser -D chrome \
&& chown -R chrome:chrome /usr/src/chrome
COPY --from=meilisearch /bin/meilisearch /bin/meilitool /bin/
##################
# 3 Install apps #
##################
# Add rootfs
COPY rootfs/ /
RUN chmod +x /etc/s6-overlay/s6-rc.d/*/run
# Uses /bin for compatibility purposes
# hadolint ignore=DL4005
RUN if [ ! -f /bin/sh ] && [ -f /usr/bin/sh ]; then ln -s /usr/bin/sh /bin/sh; fi && \
if [ ! -f /bin/bash ] && [ -f /usr/bin/bash ]; then ln -s /usr/bin/bash /bin/bash; fi
# Modules
ARG MODULES="00-banner.sh 01-custom_script.sh 00-global_var.sh"
# Automatic modules download
ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_automodules.sh" "/ha_automodules.sh"
RUN chmod 744 /ha_automodules.sh && /ha_automodules.sh "$MODULES" && rm /ha_automodules.sh
# Manual apps
ENV PACKAGES=""
# Automatic apps & bashio
ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_autoapps.sh" "/ha_autoapps.sh"
RUN chmod 744 /ha_autoapps.sh && /ha_autoapps.sh "$PACKAGES" && rm /ha_autoapps.sh
################
# 4 Entrypoint #
################
# Add entrypoint
ENV S6_STAGE2_HOOK=/ha_entrypoint.sh
ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_entrypoint.sh" "/ha_entrypoint.sh"
# Entrypoint modifications
ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_entrypoint_modif.sh" "/ha_entrypoint_modif.sh"
RUN chmod 777 /ha_entrypoint.sh /ha_entrypoint_modif.sh && /ha_entrypoint_modif.sh && rm /ha_entrypoint_modif.sh
# Standalone bashio command
ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/bashio-standalone.sh" "/.bashio-standalone.sh"
RUN chmod 777 /.bashio-standalone.sh
RUN set -e; \
extensions_dir="/usr/src/chrome/extensions"; \
mkdir -p "${extensions_dir}"; \
for entry in \
"i-dont-care-about-cookies:fllaojicojecljbmefodhfapmkghcbnh" \
"ublock-origin:cjpalhdlnbpafiamejdnhcphjbkeiagm"; do \
name="${entry%%:*}"; \
ext_id="${entry##*:}"; \
curl -fsSL "https://clients2.google.com/service/update2/crx?response=redirect&prodversion=120.0&acceptformat=crx2,crx3&x=id%3D${ext_id}%26installsource%3Dondemand%26uc" \
-o "/tmp/${name}.crx"; \
rm -rf "${extensions_dir:?}/${name}"; \
mkdir -p "${extensions_dir}/${name}"; \
rc=0; \
unzip -q "/tmp/${name}.crx" -d "${extensions_dir}/${name}" || rc=$$?; \
if [ "$$rc" -ne 0 ] && [ "$$rc" -ne 1 ]; then \
echo "ERROR: unzip failed for ${name} (rc=$$rc)"; \
exit "$$rc"; \
fi; \
rm -f "/tmp/${name}.crx"; \
done; \
chown -R chrome:chrome "${extensions_dir}"
ENTRYPOINT [ "/usr/bin/env" ]
CMD [ "/ha_entrypoint.sh" ]
############
# 5 Labels #
############
ARG BUILD_ARCH
ARG BUILD_DATE
ARG BUILD_DESCRIPTION
ARG BUILD_NAME
ARG BUILD_REF
ARG BUILD_REPOSITORY
ARG BUILD_VERSION
ENV BUILD_VERSION="${BUILD_VERSION}"
LABEL \
io.hass.name="${BUILD_NAME}" \
io.hass.description="${BUILD_DESCRIPTION}" \
io.hass.arch="${BUILD_ARCH}" \
io.hass.type="addon" \
io.hass.version=${BUILD_VERSION} \
maintainer="alexbelgium (https://github.com/alexbelgium)" \
org.opencontainers.image.title="${BUILD_NAME}" \
org.opencontainers.image.description="${BUILD_DESCRIPTION}" \
org.opencontainers.image.vendor="Home Assistant Add-ons" \
org.opencontainers.image.authors="alexbelgium (https://github.com/alexbelgium)" \
org.opencontainers.image.licenses="MIT" \
org.opencontainers.image.url="https://github.com/alexbelgium" \
org.opencontainers.image.source="https://github.com/${BUILD_REPOSITORY}" \
org.opencontainers.image.documentation="https://github.com/${BUILD_REPOSITORY}/blob/main/README.md" \
org.opencontainers.image.created=${BUILD_DATE} \
org.opencontainers.image.revision=${BUILD_REF} \
org.opencontainers.image.version=${BUILD_VERSION}
#################
# 6 Healthcheck #
#################
# Avoid spamming logs
# hadolint ignore=SC2016
RUN \
# Handle Apache configuration
if [ -d /etc/apache2/sites-available ]; then \
for file in /etc/apache2/sites-*/*.conf; do \
sed -i '/<VirtualHost/a \ \n # Match requests with the custom User-Agent "HealthCheck" \n SetEnvIf User-Agent "HealthCheck" dontlog \n # Exclude matching requests from access logs \n CustomLog ${APACHE_LOG_DIR}/access.log combined env=!dontlog' "$file"; \
done; \
fi && \
\
# Handle Nginx configuration
if [ -f /etc/nginx/nginx.conf ]; then \
awk '/http \{/{print; print "map $http_user_agent $dontlog {\n default 0;\n \"~*HealthCheck\" 1;\n}\naccess_log /var/log/nginx/access.log combined if=$dontlog;"; next}1' /etc/nginx/nginx.conf > /etc/nginx/nginx.conf.new && \
mv /etc/nginx/nginx.conf.new /etc/nginx/nginx.conf; \
fi
ENV HEALTH_PORT="3000" \
HEALTH_URL="/api/health"
HEALTHCHECK \
--interval=5s \
--retries=5 \
--start-period=30s \
--timeout=25s \
CMD curl -A "HealthCheck: Docker/1.0" -s -f "http://127.0.0.1:${HEALTH_PORT}${HEALTH_URL}" &>/dev/null || exit 1

View File

@@ -1,104 +0,0 @@
# 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 510 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.
[![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)
## Addon informations
![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)
![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)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard)
[![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)
[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 who has starred my repo!_
[![Stargazers repo roster](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 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](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2)
---
## Secrets & Security
Two secrets are required for Karakeep to work securely:
- `NEXTAUTH_SECRET`
- `MEILI_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
1. Add my Home Assistant add-ons repository
[![Add repository][repository-badge]][repository-url]
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 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
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons

View File

@@ -1,66 +0,0 @@
#include <tunables/global>
profile karakeep_addon flags=(attach_disconnected,mediate_deleted) {
#include <abstractions/base>
capability,
file,
signal,
mount,
umount,
remount,
network udp,
network tcp,
network dgram,
network stream,
network inet,
network inet6,
network netlink raw,
network unix dgram,
capability setgid,
capability setuid,
capability sys_admin,
capability dac_read_search,
# capability dac_override,
# capability sys_rawio,
# S6-Overlay
/init ix,
/run/{s6,s6-rc*,service}/** ix,
/package/** ix,
/command/** ix,
/run/{,**} rwk,
/dev/tty rw,
/bin/** ix,
/usr/bin/** ix,
/usr/lib/bashio/** ix,
/etc/s6/** rix,
/run/s6/** rix,
/etc/services.d/** rwix,
/etc/cont-init.d/** rwix,
/etc/cont-finish.d/** rwix,
/init rix,
/var/run/** mrwkl,
/var/run/ mrwkl,
/dev/i2c-1 mrwkl,
# Files required
/dev/fuse mrwkl,
/dev/sda1 mrwkl,
/dev/sdb1 mrwkl,
/dev/nvme0 mrwkl,
/dev/nvme1 mrwkl,
/dev/mmcblk0p1 mrwkl,
/dev/* mrwkl,
/tmp/** mrkwl,
# Data access
/data/** rw,
# suppress ptrace denials when using 'docker ps' or using 'ps' inside a container
ptrace (trace,read) peer=docker-default,
# docker daemon confinement requires explict allow rule for signal
signal (receive) set=(kill,term) peer=/usr/bin/docker,
}

View File

@@ -1,4 +0,0 @@
---
build_from:
aarch64: ghcr.io/karakeep-app/karakeep:0.30.0
amd64: ghcr.io/karakeep-app/karakeep:0.30.0

View File

@@ -1,58 +0,0 @@
arch:
- aarch64
- amd64
name: Karakeep
slug: karakeep
description: A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search
version: "1.8.5"
url: https://github.com/alexbelgium/hassio-addons/tree/master/karakeep
image: ghcr.io/alexbelgium/karakeep-{arch}
init: false
ports:
3000/tcp: 3000
ports_description:
3000/tcp: Web UI
webui: "[PROTO:ssl]://[HOST]:[PORT:3000]"
map:
- addon_config:rw
- share:rw
environment:
DATA_DIR: /data
XDG_CACHE_HOME: /data/cache
BROWSER_WEB_URL: http://127.0.0.1:9222
CHROME_EXTENSIONS_DIR: /usr/src/chrome/extensions
MEILI_ADDR: http://127.0.0.1:7700
MEILI_NO_ANALYTICS: "true"
DISABLE_NEW_RELEASE_CHECK: "true"
options:
TZ: Etc/UTC
DISABLE_SIGNUPS: false
NEXTAUTH_SECRET: ""
NEXTAUTH_URL: ""
MAX_ASSET_SIZE_MB: 4
OPENAI_API_KEY: ""
OCR_LANGS: ""
INFERENCE_LANG: ""
MEILI_MASTER_KEY: "" # <-- add this
CRAWLER_DOWNLOAD_BANNER_IMAGE: true
CRAWLER_STORE_SCREENSHOT: true
CRAWLER_FULL_PAGE_SCREENSHOT: true
CRAWLER_FULL_PAGE_ARCHIVE: true
CRAWLER_ENABLE_ADBLOCKER: true
CRAWLER_VIDEO_DOWNLOAD: false
schema:
TZ: str?
DISABLE_SIGNUPS: bool
NEXTAUTH_SECRET: password?
NEXTAUTH_URL: str?
MAX_ASSET_SIZE_MB: int?
OPENAI_API_KEY: password?
OCR_LANGS: str?
INFERENCE_LANG: str?
MEILI_MASTER_KEY: password? # <-- change to password?
CRAWLER_DOWNLOAD_BANNER_IMAGE: bool
CRAWLER_STORE_SCREENSHOT: bool
CRAWLER_FULL_PAGE_SCREENSHOT: bool
CRAWLER_FULL_PAGE_ARCHIVE: bool
CRAWLER_ENABLE_ADBLOCKER: bool
CRAWLER_VIDEO_DOWNLOAD: bool?

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.1 KiB

View File

@@ -1,15 +0,0 @@
#!/command/with-contenv bashio
# shellcheck shell=bash
set -e
bashio::log.info "Creating folders"
mkdir -p \
/data/cache \
/data/chrome \
/config/meili \
/usr/src/chrome/extensions
if id chrome &>/dev/null; then
chown -R chrome:chrome /data/cache /data/chrome /usr/src/chrome/extensions
fi

View File

@@ -1,50 +0,0 @@
#!/usr/bin/with-contenv bashio
# shellcheck shell=bash
set -e
generate_secret() {
# Avoid SIGPIPE from `tr` when `head` terminates early under pipefail.
(
set +o pipefail 2>/dev/null || true
tr -dc 'A-Za-z0-9' < /dev/urandom | head -c 64
)
}
set_option() {
local key="$1"
local value="$2"
# Store permanently in Home Assistant add-on options
bashio::addon.option "${key}" "${value}"
# Export into current process
export "${key}=${value}"
# Export into s6 so all services inherit it
if [ -d /var/run/s6/container_environment ]; then
printf "%s" "${value}" > "/var/run/s6/container_environment/${key}"
fi
}
load_option() {
local key="$1"
local value
value="$(bashio::config "${key}")"
export "${key}=${value}"
if [ -d /var/run/s6/container_environment ]; then
printf "%s" "${value}" > "/var/run/s6/container_environment/${key}"
fi
}
for key in MEILI_MASTER_KEY NEXTAUTH_SECRET; do
if bashio::config.has_value "${key}"; then
bashio::log.info "Using existing ${key}"
load_option "${key}"
else
bashio::log.warning "${key} not set, generating persistent secret"
value="$(generate_secret)"
set_option "${key}" "${value}"
fi
done

View File

@@ -1,46 +0,0 @@
#!/command/with-contenv bashio
# shellcheck shell=bash
set -e
EXTENSIONS_DIR="${CHROME_EXTENSIONS_DIR:-/usr/src/chrome/extensions}"
bashio::log.info "Refreshing Chromium extensions in ${EXTENSIONS_DIR}"
mkdir -p "${EXTENSIONS_DIR}"
download_extension() {
local name="$1"
local extension_id="$2"
local crx_path rc
crx_path="$(mktemp)"
if ! curl -fsSL \
"https://clients2.google.com/service/update2/crx?response=redirect&prodversion=120.0&acceptformat=crx2,crx3&x=id%3D${extension_id}%26installsource%3Dondemand%26uc" \
-o "${crx_path}"; then
rm -f "${crx_path}"
bashio::log.warning "Failed to download extension ${name}. Continuing without refresh."
return 0
fi
rm -rf "${EXTENSIONS_DIR:?}/${name}"
mkdir -p "${EXTENSIONS_DIR}/${name}"
rc=0
unzip -q "${crx_path}" -d "${EXTENSIONS_DIR}/${name}" || rc=$?
rm -f "${crx_path}"
# unzip may return 1 even though files extracted (common with CRX zip metadata)
if [ "${rc}" -ne 0 ] && [ "${rc}" -ne 1 ]; then
bashio::log.warning "Failed to unzip extension ${name} (rc=${rc}). Continuing."
return 0
fi
return 0
}
download_extension "i-dont-care-about-cookies" "fllaojicojecljbmefodhfapmkghcbnh"
download_extension "ublock-origin" "cjpalhdlnbpafiamejdnhcphjbkeiagm"
if id chrome &>/dev/null; then
chown -R chrome:chrome "${EXTENSIONS_DIR}"
fi

View File

@@ -1,21 +0,0 @@
#!/command/with-contenv bashio
# shellcheck shell=bash
set -e
EXTENSIONS_DIR="${CHROME_EXTENSIONS_DIR:-/usr/src/chrome/extensions}"
extensions=()
for extension in "${EXTENSIONS_DIR}/i-dont-care-about-cookies" "${EXTENSIONS_DIR}/ublock-origin"; do
if [ -d "$extension" ]; then
extensions+=("$extension")
fi
done
extension_flag=""
if [ ${#extensions[@]} -gt 0 ]; then
extension_flag="--load-extension=$(IFS=,; echo "${extensions[*]}")"
fi
cd /usr/src/chrome
exec su chrome -c "chromium-browser --headless=new --no-sandbox --disable-gpu --disable-dev-shm-usage --remote-debugging-address=0.0.0.0 --remote-debugging-port=9222 --hide-scrollbars --disable-crash-reporter --no-crash-upload --user-data-dir=/data/chrome ${extension_flag}"

View File

@@ -1 +0,0 @@
longrun

View File

@@ -1,7 +0,0 @@
#!/command/with-contenv bashio
# shellcheck shell=bash
set -e
mkdir -p "${MEILI_DIR}"
exec /bin/meilisearch --db-path "${MEILI_DIR}" --no-analytics --experimental-dumpless-upgrade

View File

@@ -1,8 +0,0 @@
{
"last_update": "2026-01-12",
"repository": "alexbelgium/hassio-addons",
"slug": "karakeep",
"source": "github",
"upstream_repo": "karakeep-app/karakeep",
"upstream_version": "1.8.5"
}