diff --git a/karakeep/CHANGELOG.md b/karakeep/CHANGELOG.md index fd44f8638..f88f2e8a3 100644 --- a/karakeep/CHANGELOG.md +++ b/karakeep/CHANGELOG.md @@ -1,11 +1,226 @@ - -## 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 +# 0.30.0 (New year release 🎁) + +Welcome to the 0.30.0 release of Karakeep and happy new year! This release comes with "2025 wrapped" (a bit late), PDF archives, new reader settings, avatars, reddit crawling improvements, and more! Huge thanks to our contributors for this release @esimkowitz, @Moondragon85, @rzxczxc, @colado, @Yeraze, @eriktews and everyone who shipped code, triaged bugs, or shared feedback for this release. + +> If you enjoy using Karakeep, consider supporting the project [here ☕️](https://buymeacoffee.com/mbassem) or via GitHub [here](https://github.com/sponsors/MohamedBassem). + +Buy Me A Coffee + +And in case you missed it, we now have a ☁️ managed offering ☁️ for those who don't want to self-host. We're in public beta now and you can signup [here](https://cloud.karakeep.app) 🎉. + +# New Features 🚀 + +- 2025 Wrapped is here to celebrate your year in Karakeep (#2322). +- PDF archives + - Archive bookmarks as PDFs, generated automatically during crawling or on-demand (#2309). + - Set `CRAWLER_STORE_PDF=true` to enable auto PDF archiving. +- Unified reader settings (font, size, etc) across all devices with per-device overrides (#2230). By @esimkowitz! +- Better metadata extraction: + - Reddit posts should now be crawled correctly, and banners should be fetched more reliably. + - Fixed YouTube thumbnail and author extraction. + - Fixed Amazon product image extraction (where it was sometimes showing the prime logo) (#2204, #2108). By @Yeraze +- Upload custom user avatars for more personal profiles (#2296). +- AI Setting customization: + - Customize tag styling (case, separators, language) per user. It's highly recommended to set the tag style for more consistent tags (#2312). + - Per-user toggles to disable auto-tagging and/or auto-summarization (#2275). +- Others: + - Import libraries from Matter with full export support (#2245). By @Moondragon85 + - Bulk remove bookmarks from lists (#2279). + - Add a new rule condition to rule engine: "URL Does Not Contain" (#2280). + - Configure an OpenAI proxy via `OPENAI_PROXY_URL` (#2231). By @rzxczxc + - Added `is:broken` search qualifier to show links that failed crawling (#2225). + - Edit list now in the mobile app (#2310). By @colado + +# UX Improvements ✨ + +- Our docs got a facelift! The docs got some styling, the pages got re-organized and we now have a "Using Karakeep" section that explains some of the core concepts of Karakeep. +- Replace bookmark banners and download attachments directly from the drop down menu (#2328). +- Sidebar scrollbar looks cleaner, and pending list invites show as a badge in the sidebar. +- Bookmark edit dialog now includes notes. +- Bookmark owner avatars now show up in collaborative lists. +- Mobile UI/UX improvements: + - Fixed title on mobile to be at most 2 lines long. + - Mobile settings screens should now feel more native (#2307). + - OLED-friendly colors in the Android app matching the colors of the ios app (#1958). + - Toasts on iOS now appear correctly above the open modals (#2320). By @colado + - Shared lists now appear in a dedicated subsection on mobile. + - Adding a bookmark to a list now shows a spinner during loading (#2283). + - Server version now appears in mobile settings (#2276). + - Fixed the confusing "tick button" beside the server address during login. + +# Fixes 🔧 + +- Fixed missing db indicies that was causing slow bookmark queries (#2246, #2287). +- Improved Ollama summaries by using the generate endpoint (#2324). By @eriktews +- Fixed HTML bookmark imports failing on empty folder names (#2300). +- Fixed non-link bookmarks stuck in pending summarization (#1605). +- Improved tagging prompts and error-page detection. +- Reject spoofed content types on file uploads. +- Preserve failure counts when rescheduling rate-limited domains (#2303). +- Fixed duplicate backdrop buttons in reader view (#2234). By @colado +- RSS feed fetching is now spread over the hour (#2227). +- Asset preprocessing worker timeout is now configurable (91784cd2). +- Fixed bypassing email verification in apiKey.exchange. +- Added limits on number of rss feeds and webhooks per user configurable by admins. +- Fixed a bug where failed crawling leave bookmarks as pending tagging in the admin dashboard. + +# For Developers 🛠️ + +- OpenTelemetry integration with OTLP exporter (#2318, #2321). +- CLI can list users for admins. +- We're now defaulting to Node.js 24 (the current LTS). +- Breaking: In bookmark APIs `includeContent` now defaults to `false`. This change was announced a couple months ago, and is taking effect in this release. + +# Community Projects 💡 + +- Karakeep integration for Home Assistant (#2196) by @sli-cka. Get it from [here](https://github.com/sli-cka/karakeep-homeassistant). + +# Screenshots 📸 + +## Wrapped 2025 + +![karakeep-wrapped-2025](https://github.com/user-attachments/assets/0e1e3d25-c827-4974-8f0a-9b7b4a75f859) + +## Reader Settings + +![https://github.com/user-attachments/assets/4d81cb80-f9b8-43f2-998a-736f18e33038](https://github.com/user-attachments/assets/4d81cb80-f9b8-43f2-998a-736f18e33038). + + +### AI Settings + +![https://github.com/user-attachments/assets/48032bf6-5413-44ee-9c3b-ac7b385aeccf](https://github.com/user-attachments/assets/48032bf6-5413-44ee-9c3b-ac7b385aeccf) + + + +# Upgrading 📦 + +To upgrade: +* If you're using `KARAKEEP_VERSION=release`, run `docker compose pull && docker compose up -d`. +* If you're pinning it to a specific version, bump the version and then run `docker compose pull && docker compose up -d`. + +# All Commits + +* i18n: fix en_US translation - @MohamedBassem in d472a3a1 +* fix: fix wrapped feature to only show bookmarks in 2025 - @MohamedBassem in 4077e286 +* i18n: Sync weblate translations - Weblate in 401ea6a9 +* chore: drop the experimental tag from the rule engine - @MohamedBassem in bf9d6105 +* fix: show a toast during banner upload - @MohamedBassem in 9555f409 +* fix: don't switch the bookmark back to pending on recrawl - @MohamedBassem in 79400d04 +* fix: use the Ollama generate endpoint instead of chat (#2324) - @eriktews in e8c79f29 +* feat: add replace banner and attachment download (#2328) - @MohamedBassem in 3d652eee +* feat: Add bulk remove from list (#2279) - @MohamedBassem in 7a76216e +* feat: add "URL Does Not Contain" condition to rule engine (#2280) - @MohamedBassem in b20ba9cf +* feat: 2025 wrapped (#2322) - @MohamedBassem in a0b4a26a +* chore: worker tracing (#2321) - @MohamedBassem in 7ab7db8e +* feat(landing): add corporate pricing - @MohamedBassem in d852ee1a +* fix(mobile): mobile modal UI issues (#2320) - @colado in a43d375f +* ci: fix tests - @MohamedBassem in 9d6b1282 +* feat: change default for tag style to be title case with spaces - @MohamedBassem in 9098a5a6 +* fix: more tagging tweaks - @MohamedBassem in c1cbaa8a +* build: fix broken CI - @MohamedBassem in a5ce977d +* fix: change prompt to better recognize error pages - @MohamedBassem in f5a5c14e +* refactor: reduce duplication in compare-models tool - @MohamedBassem in f00287ed +* chore: add tracing for email functions - @MohamedBassem in ba8d84a5 +* feat(mobile): create new list edit screen (#2310) - @colado in 30fa06fe +* feat: Add open telemetry (#2318) - @MohamedBassem in 5537fe85 +* fix: reset tagging status on crawl failure (#2316) - @MohamedBassem in f7920bdc +* feat: add the ability to specify a different changelog version - @MohamedBassem in 10820761 +* fix: remove duplicate mobile backdrop button in reader view (#2234) - @esimkowitz in 3f44e319 +* fix(landing): fix cloud banner on mobile - @MohamedBassem in 23f28530 +* refactor: add suspense boundary in sidebar layout - @MohamedBassem in 3c3d8685 +* feat(mobile): make the settings menu look more native (#2307) - @MohamedBassem in 6ee48ffb +* feat(web): better looking scrollbar in the sidebar - @MohamedBassem in f7523a21 +* feat(mobile): use oled friendly colors for android app. fixes #1958 - @MohamedBassem in e800d744 +* refactor: migrate toasts to sonner - @MohamedBassem in 173fb99a +* feat: add customizable tag styles (#2312) - @MohamedBassem in af3010ab +* feat: add Matter import support (#2245) - @Moondragon85 in 93630ce8 +* feat: support archiving as pdf (#2309) - @MohamedBassem in 267db791 +* feat: add OPENAI_PROXY_URL configuration and support for proxy in OpenAI client (#2231) - @rzxczxc in bb6b742a +* fix(tests): fix the asset upload tests - @MohamedBassem in e82694de +* fix: reject spoofed content types on uploads - @MohamedBassem in 2dbdf76c +* deps: upgrade tesseract to v7 - @MohamedBassem in 347793ad +* feat(landing): announce cloud public beta in landing page - @MohamedBassem in c3b2326c +* chore: add a tool for comparing perf of different models - @MohamedBassem in 1dfa5d12 +* feat: add notes to the bookmark edit dialog - @MohamedBassem in ecb7a710 +* fix(restate): change journal retention for services to 3d - @MohamedBassem in 0efffdcc +* fix(cli): migrate bookmark source in migration command - @MohamedBassem in 65cfa871 +* fix: preserve failure count when rescheduling rate limited domains (#2303) - @MohamedBassem in ddd4b578 +* feat: show bookmark owner icon in shared lists (#2277) - @MohamedBassem in ef27670f +* fix: make avatars public - @MohamedBassem in f7d34627 +* refactor: move assets to their own model (#2301) - @MohamedBassem in 013ca67c +* feat: add support for user avatars (#2296) - @MohamedBassem in 314c363e +* fix: handle empty folder names in HTML bookmark imports (#2300) - @MohamedBassem in 3408e6e4 +* feat: add a warning about viewing archives inline. fixes #2286 - @MohamedBassem in e336513f +* fix(tests): fix the user setting tests - @MohamedBassem in 258bebe0 +* feat: Add user settings to disable auto tagging/summarization (#2275) - @MohamedBassem in 0bdba54b +* feat(mobile): Convert server address editing to modal in mobile app (#2290) - @MohamedBassem in ece68ed0 +* fix: check quota usage instead bookmark transaction - @MohamedBassem in ca4bfa4c +* fix: optimize tagging db queries (#2287) - @MohamedBassem in e18dc4c9 +* docs: shuffle some docs around - @MohamedBassem in 4762da12 +* docs: add RSS feeds integration documentation (#2288) - @MohamedBassem in 903aa5e9 +* feat(restate): Add a var to control whether to expose core services or not - @MohamedBassem in dc8ab862 +* feat: add more restate semaphore controls - @MohamedBassem in 58eb6c00 +* feat(mobile): Show shared lists under a subsection - @MohamedBassem in 837dea5e +* fix(mobile): Fix title line clamp to 2 lines - @MohamedBassem in 15cfa137 +* fix(mobile): Add loading spinner to mobile list button (#2283) - @MohamedBassem in 7b98c52a +* feat: add server version display to mobile app settings (#2276) - @MohamedBassem in bd969b34 +* fix: add authentication checks to settings layout (#2274) - @MohamedBassem in e53f3ae5 +* fix: only trigger search autocomplete on first search char - @MohamedBassem in 92e352f3 +* feat(landing): remove waitlist link. fixes #2270 - @MohamedBassem in e842c5a7 +* fix: don't fail the script if the user karakeep already exists. fixes #2242 - @MohamedBassem in e78e5129 +* fix: collapse reader settings by default - @MohamedBassem in 3955f91a +* docs: Add icons beside category names - @MohamedBassem in 9021822a +* Revert "fix: fix restate service to return control to restate service on timeout" - @MohamedBassem in 510174db +* feat: Add unified reader settings with local overrides (#2230) - @esimkowitz in 7f4202af +* fix: fix restate service to return control to restate service on timeout - @MohamedBassem in 6db14ac4 +* fix: non-link bookmarks where stuck in pending summarization. Fixes #1605 - @MohamedBassem in d7357118 +* fix: move trpc error logging inside the dev check - @MohamedBassem in 0b65e5a4 +* fix: Fix Amazon product image extraction on amazon.com URLs (#2108) - @Yeraze in b3196354 +* feat: use reddit API for metadata extraction. Fixes #1853 #1883 - @MohamedBassem in f5c32d94 +* fix: use GET requests for the content type request - @MohamedBassem in d6dd8ebd +* docs: fix sidebar on mobile - @MohamedBassem in f111cba9 +* feat: Add limits on number of rss feeds and webhooks per user - @MohamedBassem in 74df8bd7 +* release(cli): Bump CLI version to 0.29.1 - @MohamedBassem in 697c853a +* readme: some readme updates - @MohamedBassem in 1ebc721c +* docs: Update screenshots in docs - @MohamedBassem in c6cf4188 +* docs: Adding user guides - @MohamedBassem in 04b9c291 +* docs: drop docs for old versions - @MohamedBassem in fecb0079 +* docs: restructure the docs - @MohamedBassem in af69f637 +* docs: restyle the docs - @MohamedBassem in b4344401 +* ci: run CI with node 24 - @MohamedBassem in 2bdba536 +* deps: Upgrade to nodejs 24 - @MohamedBassem in 480abce4 +* fix!: changing default for includeContent to be false in the API - @MohamedBassem in 1369ad01 +* deps: Upgrade nextjs to 15.3.8 - @MohamedBassem in 80278ecf +* deps: Upgrade nextjs to 15.3.7 - @MohamedBassem in 74bdc186 +* fix: add more indicies for faster bookmark queries (#2246) - @MohamedBassem in 683083f4 +* feat: make asset preprocessing worker timeout configurable - @Claude in 91784cd2 +* fix: Add cache control header on asset endpoints - @MohamedBassem in 3e8cc745 +* chore: Allowing multi user benchmarks and adding more coverage - @MohamedBassem in 265b6773 +* feat(cli): Add ability to list users for the admin in the CLI - @MohamedBassem in 69a756aa +* fix: fix correctly accounting for text bookmark in import sessions. #2208 - @MohamedBassem in 6886385c +* fix: check import quota before importing bookmarks (#2232) - @MohamedBassem in 20d3761c +* build: fix typecheck error in query explainer - @MohamedBassem in b6c2dadd +* fix: migrate to metascraper-x from metascraper-twitter - @MohamedBassem in c6f93b3b +* feat: add is:broken search qualifier for broken links (#2225) - @MohamedBassem in 1f43f232 +* feat: spread feed fetch scheduling deterministically over the hour (#2227) - @MohamedBassem in 13a090c4 +* fix: better extraction for youtube thumbnails. #2204 - @MohamedBassem in e3cc5463 +* fix: remove queue triggers outside of updateTags transaction - @MohamedBassem in cf2a12c8 +* chore: add benchmarks (#2229) - @MohamedBassem in 6180c662 +* build: dont update latest tags on release - @MohamedBassem in de98873a +* deps: Upgrade nextjs to 15.3.6 - @MohamedBassem in 20081a3a +* feat: add a notification badge for list invitations - @MohamedBassem in 3c6b8e97 +* docs: add karakeep integration for Home Assistant (#2196) - @sli-cka in 9a339385 +* fix: regen turnstile token on signup resubmission - @MohamedBassem in 9257b534 +* feat(landing): Add more features to the homepage - @MohamedBassem in 9a6d36f2 +* ci: run arm docker image builds on arm machines - @MohamedBassem in 3421246d +* ci: parallelize the docker workflow for platforms - @MohamedBassem in 2e889617 +* fix: reenable idempotency key for search indexing - @MohamedBassem in 2ef751ef +* fix: fix bypass email verification in apiKey.exchange - @MohamedBassem in e4f434e7 +* readme: add collaborative lists to the list of features - @MohamedBassem in d6d319d3 +* fix: Add restate queued idempotency (#2169) - @MohamedBassem in a71b9505 +* feat: add support for turnstile on signup - @MohamedBassem in b12c1c3a +* build: fix npm trusted publishing - @MohamedBassem in 4898b6be +* release: cli, mcp and sdk - @MohamedBassem in 28d6750e +* release(extension): Release version 1.2.8 - @MohamedBassem in fdea0861 +* release(mobile): Bump mobile version to 1.8.3 - @MohamedBassem in 8da5b598 +* release(docs): release the 0.29 docs - @MohamedBassem in 97c386a4 diff --git a/karakeep/DOCS.md b/karakeep/DOCS.md new file mode 100644 index 000000000..f1ab2789a --- /dev/null +++ b/karakeep/DOCS.md @@ -0,0 +1,42 @@ +# Home Assistant add-on: Karakeep (all-in-one) 💾 by Fabio Garavini + +The Karakeep Addon is a bookmark-everything app with a touch of AI, designed specifically for data hoarders. This addon allows you to save and organize your favorite bookmarks, with features like AI-powered search and recommendation. + +## Configuration + +- `NEXTAUTH_URL`: The URL of the Karakeep instance. Example `http://:3011`. +- `TZ`: The timezone to use for the addon. Example `Europe/Rome`. +- `DISABLE_SIGNUPS`: Whether to disable signups for new users. Defaults to `false`. +- `NEXTAUTH_SECRET`: A secret key used for authentication. Defaults to a random value. +- `MAX_ASSET_SIZE_MB`: The maximum size of assets (e.g. images) that can be uploaded. Defaults to `4`. +- `OCR_LANGS`: A comma-separated list of languages to use for optical character recognition (OCR). Defaults to `eng`. +- `OCR_CONFIDENCE_THRESHOLD`: The minimum confidence threshold for OCR results. Defaults to `50`. +- `OPENAI_API_KEY`: An API key for OpenAI. Optional. +- `OPENAI_BASE_URL`: The base URL of the OpenAI API. Optional. +- `OLLAMA_BASE_URL`: The base URL of the OLLAMA API. Optional. +- `INFERENCE_TEXT_MODEL`: The text model to use for inference. Defaults to `gpt-4o-mini`. +- `INFERENCE_IMAGE_MODEL`: The image model to use for inference. Defaults to `gpt-4o-mini`. +- `EMBEDDING_TEXT_MODEL`: The text model to use for embedding. Defaults to `text-embedding-3-small`. +- `INFERENCE_CONTEXT_LENGTH`: The length of the context to use for inference. Defaults to `2048`. +- `INFERENCE_LANG`: The language to use for inference. Defaults to `english`. +- `INFERENCE_JOB_TIMEOUT_SEC`: The timeout for inference jobs in seconds. Defaults to `30`. + +More informations about other configs can be found in the [official documentation](https://docs.karakeep.app/configuration) + +## Ports + +The Karakeep Addon exposes the following ports: + +- `3000/tcp`: The web UI port. + +## Installation + +To install the Karakeep Addon, follow these steps: + +1. Open the Home Assistant UI and navigate to the Add-ons page. +1. Click the "Karakeep" addon. +1. Click the "Install" button. +1. (Optional) under `Configuration` set `NEXTAUTH_URL` as specified above +1. Click the "Open Web UI" button. +1. Create a new user. +1. Happy hoarding! diff --git a/karakeep/Dockerfile b/karakeep/Dockerfile index f59dad295..60cadba20 100644 --- a/karakeep/Dockerfile +++ b/karakeep/Dockerfile @@ -1,42 +1,20 @@ -#============================# -# ALEXBELGIUM'S DOCKERFILE # -#============================# -# _.------. -# _.-` ('>.-`"""-. -# '.--'` _'` _ .--.) -# -' '-.-';` ` -# ' - _.' ``'--. -# '---` .-'""` -# /` -#=== Home Assistant Addon ===# +# check=skip=SecretsUsedInArgOrEnv +ARG BUILD_FROM=ghcr.io/karakeep-app/karakeep:0.30.0 -################# -# 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 - +# Environment variables ENV \ - DATA_DIR="/data" \ + DATA_DIR="/share/karakeep" \ 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_MASTER_KEY="0uIHQXWthY2L2yqCWGVGu2axN+l4qcDEc+Of/7e8X7bEyZ8k" \ MEILI_NO_ANALYTICS=true \ XDG_CACHE_HOME="/data/cache" @@ -48,147 +26,96 @@ ENV \ MEILI_SERVER_PROVIDER=docker \ MEILI_ENV=production -# Image specific modifications +ENV \ + SERVICE_PORT=3000 \ + NGINX_PORT=8080 + +# NGINX Install +RUN \ + apk add --no-cache \ + bash \ + openssl \ + nginx \ + && rm -rf /etc/nginx + +# Set shell +SHELL ["/bin/bash", "-o", "pipefail", "-c"] + +# Addon base configuration +ARG BUILD_ARCH=amd64 +# renovate: datasource=github-releases packageName=hassio-addons/bashio +ARG BASHIO_VERSION="v0.17.5" +# renovate: datasource=github-releases packageName=home-assistant/tempio +ARG TEMPIO_VERSION="2024.11.2" +RUN \ + set -o pipefail \ + && apk add --no-cache --virtual .build-dependencies \ + tar \ + xz \ + && apk add --no-cache \ + libcrypto3 \ + libssl3 \ + musl-utils \ + musl \ + curl \ + jq \ + tzdata \ + \ + && curl -J -L "https://github.com/hassio-addons/bashio/archive/${BASHIO_VERSION}.tar.gz" -o /tmp/bashio.tar.gz \ + && mkdir /tmp/bashio \ + && tar zxvf /tmp/bashio.tar.gz --strip 1 -C /tmp/bashio \ + \ + && mv /tmp/bashio/lib /usr/lib/bashio \ + && ln -s /usr/lib/bashio/bashio /usr/bin/bashio \ + \ + && curl -L -s "https://github.com/home-assistant/tempio/releases/download/${TEMPIO_VERSION}/tempio_${BUILD_ARCH}" -o /usr/bin/tempio \ + && chmod a+x /usr/bin/tempio \ + \ + && apk del --no-cache --purge .build-dependencies \ + && rm -rf /tmp/* + +# Installs latest Chromium package. RUN \ apk upgrade --no-cache --available \ && apk add --no-cache \ - chromium \ - chromium-swiftshader \ - ttf-freefont \ - font-noto-emoji \ - font-wqy-zenhei \ - unzip \ + chromium \ + chromium-swiftshader \ + ttf-freefont \ + font-noto-emoji \ + font-wqy-zenhei \ && 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 # -################## +COPY .common/addon-config / +COPY .common/nginx / -# Add rootfs COPY rootfs/ / -RUN chmod +x /etc/s6-overlay/s6-rc.d/*/run +ARG BUILD_VERSION \ + BUILD_DATE \ + BUILD_DESCRIPTION \ + BUILD_NAME \ + BUILD_REF \ + BUILD_REPOSITORY -# 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)" \ + io.hass.version="${BUILD_VERSION}" \ + maintainer="Fabio Garavini " \ 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.vendor="Fabio Garavini Hassio Add-ons" \ + org.opencontainers.image.authors="Fabio Garavini " \ org.opencontainers.image.licenses="MIT" \ - org.opencontainers.image.url="https://github.com/alexbelgium" \ + org.opencontainers.image.url="https://github.com/fabio-garavini" \ 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 '/ /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 diff --git a/karakeep/README.md b/karakeep/README.md index eb54c9177..2c67d8988 100644 --- a/karakeep/README.md +++ b/karakeep/README.md @@ -1,104 +1 @@ -# 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. - -[![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 +Borrowed from Fabio Garavini \ No newline at end of file diff --git a/karakeep/addon_info.yaml b/karakeep/addon_info.yaml new file mode 100644 index 000000000..fe068df2b --- /dev/null +++ b/karakeep/addon_info.yaml @@ -0,0 +1,16 @@ +source: + type: docker + repo: ghcr.io/karakeep-app/karakeep + current_version: 0.30.0 + version_template: regex:^(?\d+)\.(?\d+)\.(?\d+)$ +config: + version_template: "{{major}}.{{minor}}.{{patch}}" + patch: 0 + image: fabioogaravini/hassio-karakeep +build: + image: ghcr.io/karakeep-app/karakeep + version_template: "{{major}}.{{minor}}.{{patch}}" +changelog: + source: github-releases + repo: karakeep-app/karakeep + version_template: v{{major}}.{{minor}}.{{patch}} diff --git a/karakeep/apparmor.txt b/karakeep/apparmor.txt deleted file mode 100644 index 68f11001b..000000000 --- a/karakeep/apparmor.txt +++ /dev/null @@ -1,66 +0,0 @@ -#include - -profile karakeep_addon flags=(attach_disconnected,mediate_deleted) { - #include - - 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, - -} diff --git a/karakeep/build.yaml b/karakeep/build.yaml index ca94365f9..63b14388d 100644 --- a/karakeep/build.yaml +++ b/karakeep/build.yaml @@ -1,4 +1,3 @@ ---- build_from: aarch64: ghcr.io/karakeep-app/karakeep:0.30.0 amd64: ghcr.io/karakeep-app/karakeep:0.30.0 diff --git a/karakeep/config.yaml b/karakeep/config.yaml index eb8817ab9..6705a2a2d 100644 --- a/karakeep/config.yaml +++ b/karakeep/config.yaml @@ -1,58 +1,67 @@ +name: Karakeep +version: 0.30.0-4 +slug: karakeep +description: bookmark-everything app with a touch of AI for the data hoarders out there +url: https://karakeep.app/ +webui: "[PROTO:ssl]://[HOST]:[PORT:8080]" 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]" +hassio_api: true 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 + - type: addon_config + read_only: false + - type: share + read_only: false + - type: ssl +backup: cold +backup_exclude: + - "**/logs" schema: TZ: str? + ssl: bool + certfile: str? + keyfile: str? DISABLE_SIGNUPS: bool - NEXTAUTH_SECRET: password? - NEXTAUTH_URL: str? + NEXTAUTH_SECRET: password MAX_ASSET_SIZE_MB: int? - OPENAI_API_KEY: password? + NEXTAUTH_URL: str? OCR_LANGS: str? + OCR_CONFIDENCE_THRESHOLD: int(0,100)? + OPENAI_BASE_URL: str? + OPENAI_API_KEY: password? + OLLAMA_BASE_URL: str? + INFERENCE_TEXT_MODEL: str? + INFERENCE_IMAGE_MODEL: str? + EMBEDDING_TEXT_MODEL: str? + INFERENCE_CONTEXT_LENGTH: int(0,)? INFERENCE_LANG: str? - MEILI_MASTER_KEY: password? # <-- change to password? + INFERENCE_JOB_TIMEOUT_SEC: int(0,)? CRAWLER_DOWNLOAD_BANNER_IMAGE: bool CRAWLER_STORE_SCREENSHOT: bool CRAWLER_FULL_PAGE_SCREENSHOT: bool CRAWLER_FULL_PAGE_ARCHIVE: bool - CRAWLER_ENABLE_ADBLOCKER: bool + CRAWLER_JOB_TIMEOUT_SEC: int(0,)? + CRAWLER_NAVIGATE_TIMEOUT_SEC: int(0,)? CRAWLER_VIDEO_DOWNLOAD: bool? + CRAWLER_VIDEO_DOWNLOAD_MAX_SIZE: int? + CRAWLER_VIDEO_DOWNLOAD_TIMEOUT_SEC: int(0,)? + CRAWLER_ENABLE_ADBLOCKER: bool +options: + TZ: Etc/UTC + ssl: true + certfile: fullchain.pem + keyfile: privkey.pem + DISABLE_SIGNUPS: false + NEXTAUTH_SECRET: jnE2An0WyIKZvO+WgKJrn8WPW+c3DzV+c9ntBp8CdobTOmpJ + MAX_ASSET_SIZE_MB: 4 + CRAWLER_DOWNLOAD_BANNER_IMAGE: true + CRAWLER_STORE_SCREENSHOT: false + CRAWLER_FULL_PAGE_SCREENSHOT: false + CRAWLER_FULL_PAGE_ARCHIVE: false + CRAWLER_ENABLE_ADBLOCKER: true +ports: + 8080/tcp: 3011 +ports_description: + 8080/tcp: Web UI diff --git a/karakeep/icon.png b/karakeep/icon.png index 59e8dc950..11f17c6b8 100644 Binary files a/karakeep/icon.png and b/karakeep/icon.png differ diff --git a/karakeep/logo.png b/karakeep/logo.png index 59e8dc950..891802b48 100644 Binary files a/karakeep/logo.png and b/karakeep/logo.png differ diff --git a/karakeep/rootfs/etc/cont-init.d/90-folders.sh b/karakeep/rootfs/etc/cont-init.d/90-folders.sh deleted file mode 100755 index 864dd25ea..000000000 --- a/karakeep/rootfs/etc/cont-init.d/90-folders.sh +++ /dev/null @@ -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 diff --git a/karakeep/rootfs/etc/cont-init.d/91-secrets.sh b/karakeep/rootfs/etc/cont-init.d/91-secrets.sh deleted file mode 100755 index b22cfd2e7..000000000 --- a/karakeep/rootfs/etc/cont-init.d/91-secrets.sh +++ /dev/null @@ -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 diff --git a/karakeep/rootfs/etc/cont-init.d/92-chrome-extensions.sh b/karakeep/rootfs/etc/cont-init.d/92-chrome-extensions.sh deleted file mode 100755 index 4df7b761f..000000000 --- a/karakeep/rootfs/etc/cont-init.d/92-chrome-extensions.sh +++ /dev/null @@ -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 diff --git a/karakeep/rootfs/etc/fonts/local.conf b/karakeep/rootfs/etc/fonts/local.conf new file mode 100644 index 000000000..ed6c08b91 --- /dev/null +++ b/karakeep/rootfs/etc/fonts/local.conf @@ -0,0 +1,31 @@ + + + + + + sans-serif + + Main sans-serif font name goes here + Noto Color Emoji + Noto Emoji + + + + + serif + + Main serif font name goes here + Noto Color Emoji + Noto Emoji + + + + + monospace + + Main monospace font name goes here + Noto Color Emoji + Noto Emoji + + + \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/includes/mime.types b/karakeep/rootfs/etc/nginx/includes/mime.types new file mode 100644 index 000000000..c23021204 --- /dev/null +++ b/karakeep/rootfs/etc/nginx/includes/mime.types @@ -0,0 +1,96 @@ +types { + text/html html htm shtml; + text/css css; + text/xml xml; + image/gif gif; + image/jpeg jpeg jpg; + application/javascript js; + application/atom+xml atom; + application/rss+xml rss; + + text/mathml mml; + text/plain txt; + text/vnd.sun.j2me.app-descriptor jad; + text/vnd.wap.wml wml; + text/x-component htc; + + image/png png; + image/svg+xml svg svgz; + image/tiff tif tiff; + image/vnd.wap.wbmp wbmp; + image/webp webp; + image/x-icon ico; + image/x-jng jng; + image/x-ms-bmp bmp; + + font/woff woff; + font/woff2 woff2; + + application/java-archive jar war ear; + application/json json; + application/mac-binhex40 hqx; + application/msword doc; + application/pdf pdf; + application/postscript ps eps ai; + application/rtf rtf; + application/vnd.apple.mpegurl m3u8; + application/vnd.google-earth.kml+xml kml; + application/vnd.google-earth.kmz kmz; + application/vnd.ms-excel xls; + application/vnd.ms-fontobject eot; + application/vnd.ms-powerpoint ppt; + application/vnd.oasis.opendocument.graphics odg; + application/vnd.oasis.opendocument.presentation odp; + application/vnd.oasis.opendocument.spreadsheet ods; + application/vnd.oasis.opendocument.text odt; + application/vnd.openxmlformats-officedocument.presentationml.presentation + pptx; + application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + xlsx; + application/vnd.openxmlformats-officedocument.wordprocessingml.document + docx; + application/vnd.wap.wmlc wmlc; + application/x-7z-compressed 7z; + application/x-cocoa cco; + application/x-java-archive-diff jardiff; + application/x-java-jnlp-file jnlp; + application/x-makeself run; + application/x-perl pl pm; + application/x-pilot prc pdb; + application/x-rar-compressed rar; + application/x-redhat-package-manager rpm; + application/x-sea sea; + application/x-shockwave-flash swf; + application/x-stuffit sit; + application/x-tcl tcl tk; + application/x-x509-ca-cert der pem crt; + application/x-xpinstall xpi; + application/xhtml+xml xhtml; + application/xspf+xml xspf; + application/zip zip; + + application/octet-stream bin exe dll; + application/octet-stream deb; + application/octet-stream dmg; + application/octet-stream iso img; + application/octet-stream msi msp msm; + + audio/midi mid midi kar; + audio/mpeg mp3; + audio/ogg ogg; + audio/x-m4a m4a; + audio/x-realaudio ra; + + video/3gpp 3gpp 3gp; + video/mp2t ts; + video/mp4 mp4; + video/mpeg mpeg mpg; + video/quicktime mov; + video/webm webm; + video/x-flv flv; + video/x-m4v m4v; + video/x-mng mng; + video/x-ms-asf asx asf; + video/x-ms-wmv wmv; + video/x-msvideo avi; +} \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/includes/proxy_params.conf b/karakeep/rootfs/etc/nginx/includes/proxy_params.conf new file mode 100644 index 000000000..7aa69699a --- /dev/null +++ b/karakeep/rootfs/etc/nginx/includes/proxy_params.conf @@ -0,0 +1,15 @@ +proxy_http_version 1.1; +proxy_ignore_client_abort off; +proxy_read_timeout 86400s; +proxy_redirect off; +proxy_send_timeout 86400s; +proxy_max_temp_file_size 0; + +proxy_set_header Accept-Encoding ""; +proxy_set_header Connection $connection_upgrade; +proxy_set_header Host $http_host; +proxy_set_header Upgrade $http_upgrade; +proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; +proxy_set_header X-Forwarded-Proto $scheme; +proxy_set_header X-NginX-Proxy true; +proxy_set_header X-Real-IP $remote_addr; \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/includes/resolver.conf b/karakeep/rootfs/etc/nginx/includes/resolver.conf new file mode 100644 index 000000000..be0943d63 --- /dev/null +++ b/karakeep/rootfs/etc/nginx/includes/resolver.conf @@ -0,0 +1 @@ +resolver 127.0.0.11 ipv6=off; \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/includes/server_params.conf b/karakeep/rootfs/etc/nginx/includes/server_params.conf new file mode 100644 index 000000000..f67263b2c --- /dev/null +++ b/karakeep/rootfs/etc/nginx/includes/server_params.conf @@ -0,0 +1,6 @@ +root /dev/null; +server_name $hostname; + +add_header X-Content-Type-Options nosniff; +add_header X-XSS-Protection "1; mode=block"; +add_header X-Robots-Tag none; \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/includes/ssl_params.conf b/karakeep/rootfs/etc/nginx/includes/ssl_params.conf new file mode 100644 index 000000000..adb5185f2 --- /dev/null +++ b/karakeep/rootfs/etc/nginx/includes/ssl_params.conf @@ -0,0 +1,8 @@ +ssl_protocols TLSv1.2 TLSv1.3; +ssl_prefer_server_ciphers off; +ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384; +ssl_session_timeout 10m; +ssl_session_cache shared:SSL:10m; +ssl_session_tickets off; +#ssl_stapling on; +#ssl_stapling_verify on; \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/nginx.conf b/karakeep/rootfs/etc/nginx/nginx.conf new file mode 100644 index 000000000..cb593fd2a --- /dev/null +++ b/karakeep/rootfs/etc/nginx/nginx.conf @@ -0,0 +1,52 @@ +# Run nginx in foreground. +daemon off; + +# This is run inside Docker. +user root; + +# Pid storage location. +pid /var/run/nginx.pid; + +# Set number of worker processes. +worker_processes 1; + +# Enables the use of JIT for regular expressions to speed-up their processing. +pcre_jit on; + +# Write error log to the add-on log. +error_log /proc/1/fd/1 error; + +# Load allowed environment vars +env HASSIO_TOKEN; + +# Load dynamic modules. +include /etc/nginx/modules/*.conf; + +# Max num of simultaneous connections by a worker process. +events { + worker_connections 512; +} + +http { + include /etc/nginx/includes/mime.types; + + access_log off; + client_max_body_size 4G; + default_type application/octet-stream; + gzip on; + keepalive_timeout 65; + sendfile on; + server_tokens off; + tcp_nodelay on; + tcp_nopush on; + + map $http_upgrade $connection_upgrade { + default upgrade; + '' close; + } + + include /etc/nginx/includes/resolver.conf; + include /etc/nginx/includes/upstream.conf; + + include /etc/nginx/servers/*.conf; +} \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-web/dependencies.d/svc-chrome b/karakeep/rootfs/etc/nginx/servers/.gitkeep similarity index 100% rename from karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-web/dependencies.d/svc-chrome rename to karakeep/rootfs/etc/nginx/servers/.gitkeep diff --git a/karakeep/rootfs/etc/nginx/templates/direct.gtpl b/karakeep/rootfs/etc/nginx/templates/direct.gtpl new file mode 100644 index 000000000..2c8d137a1 --- /dev/null +++ b/karakeep/rootfs/etc/nginx/templates/direct.gtpl @@ -0,0 +1,31 @@ +server { + {{ if not .ssl }} + listen {{ .port }} default_server; + {{ else }} + listen {{ .port }} default_server ssl; + {{ end }} + + include /etc/nginx/includes/server_params.conf; + include /etc/nginx/includes/proxy_params.conf; + + {{ if .ssl }} + include /etc/nginx/includes/ssl_params.conf; + + ssl_certificate {{ .certfile }}; + ssl_certificate_key {{ .keyfile }}; + {{ end }} + + location / { + {{ if .ingress_user }} + set $ingress_user ""; + + if ($remote_addr = 172.30.32.2) { + set $ingress_user {{ .ingress_user }}; + } + + proxy_set_header X-WebAuth-User $ingress_user; + {{ end }} + + proxy_pass {{ .protocol }}://backend; + } +} \ No newline at end of file diff --git a/karakeep/rootfs/etc/nginx/templates/upstream.gtpl b/karakeep/rootfs/etc/nginx/templates/upstream.gtpl new file mode 100644 index 000000000..d37ee59f9 --- /dev/null +++ b/karakeep/rootfs/etc/nginx/templates/upstream.gtpl @@ -0,0 +1,3 @@ +upstream backend { + server 127.0.0.1:{{ .port }}; +} \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-web/dependencies.d/svc-meilisearch b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/dependencies.d/base similarity index 100% rename from karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-web/dependencies.d/svc-meilisearch rename to karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/dependencies.d/base diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/run b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/run new file mode 100644 index 000000000..e3fba3022 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/run @@ -0,0 +1,59 @@ +#!/command/with-contenv bash +# shellcheck shell=bash + +set -e + +echo " Loading env variables:" + +OPTIONS_SOURCE=/data/options.json + +while read -r -d $'\0' key && read -r value; do + + line="$key=$value" + + # log redacted config + case "$key" in + *PASS*|*SECRET*|*KEY*|*TOKEN*) + echo " $key=******" + ;; + *) + echo " $line" + ;; + esac + + export $key=$value + + # set .env + echo "$line" >> /.env || true + + # set /etc/environment + echo "$line" >> /etc/environment + + # For s6 + if [ -d /var/run/s6/container_environment ]; then + printf "%s" "$value" > /var/run/s6/container_environment/"$key" + fi + + echo "export $line" >> ~/.bashrc +done < <( + jq -r ' + reduce to_entries[] as $item ( + {}; + if $item.value | type == "object" then + . + $item.value + else + . + { ($item.key): $item.value } + end + ) + | to_entries[] + | "\(.key)\u0000\(.value|tostring)" + ' "$OPTIONS_SOURCE" +) + +if [ -n "$TZ" ] && [ -f /etc/localtime ]; then + if [ -f /usr/share/zoneinfo/"$TZ" ]; then + echo "Timezone set to $TZ" + ln -snf /usr/share/zoneinfo/"$TZ" /etc/localtime + echo "$TZ" >/etc/timezone + fi +fi \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/type b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/type new file mode 100644 index 000000000..3d92b15f2 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/type @@ -0,0 +1 @@ +oneshot \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/up b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/up new file mode 100644 index 000000000..b6f7a938e --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-addon-config/up @@ -0,0 +1 @@ +/etc/s6-overlay/s6-rc.d/init-addon-config/run \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-workers/dependencies.d/svc-chrome b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-db-migration/dependencies.d/init-folders similarity index 100% rename from karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-workers/dependencies.d/svc-chrome rename to karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-db-migration/dependencies.d/init-folders diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-workers/dependencies.d/svc-meilisearch b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-db-migration/dependencies.d/svc-chrome similarity index 100% rename from karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-workers/dependencies.d/svc-meilisearch rename to karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-db-migration/dependencies.d/svc-chrome diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-db-migration/dependencies.d/svc-meilisearch b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-db-migration/dependencies.d/svc-meilisearch new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/dependencies.d/init-addon-config b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/dependencies.d/init-addon-config new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/run b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/run new file mode 100644 index 000000000..eb00b6a41 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/run @@ -0,0 +1,8 @@ +#!/command/with-contenv bash +# shellcheck shell=bash + +set -e + +if [ ! -d "$DATA_DIR" ]; then + mkdir -p "$DATA_DIR" +fi \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/type b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/type new file mode 100644 index 000000000..3d92b15f2 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/type @@ -0,0 +1 @@ +oneshot \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/up b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/up new file mode 100644 index 000000000..1fd74db37 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-folders/up @@ -0,0 +1 @@ +/etc/s6-overlay/s6-rc.d/init-folders/run \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/dependencies.d/init-addon-config b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/dependencies.d/init-addon-config new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/run b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/run new file mode 100644 index 000000000..8203b6a4f --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/run @@ -0,0 +1,49 @@ +#!/command/with-contenv bashio +# shellcheck shell=bash + +set -e + +OPTIONS_SOURCE=/data/options.json + +service_port=${SERVICE_PORT:-80} +service_protocol=${SERVICE_PROTOCOL:-http} +nginx_port=${NGINX_PORT:-8080} +certfile="/ssl/$(jq -r '.certfile' $OPTIONS_SOURCE)" +keyfile="/ssl/$(jq -r '.keyfile' $OPTIONS_SOURCE)" +ingress_user=$(jq -r '.ingress_user' $OPTIONS_SOURCE) + +# Generate upstream configuration +printf '{ "port": "%s" }' "$service_port" \ + | tempio \ + -template /etc/nginx/templates/upstream.gtpl \ + -out /etc/nginx/includes/upstream.conf + +if jq -e '.ssl == true' $OPTIONS_SOURCE > /dev/null; then + # Require certfile and keyfile + #bashio::config.require 'certfile' + #bashio::config.require 'keyfile' + + # If certfile or keyfile does not exist, generate self-signed cert + if [ ! -f "$certfile" ] || [ ! -f "$keyfile" ]; then + bashio::log.warning "SSL is enabled, but either certfile, keyfile or both are missing. Falling back to a self-signed certificate..." + + certfile="/data/ssl/fullchain.pem" + keyfile="/data/ssl/privkey.pem" + + /usr/local/bin/ssl-check-generate.sh "$certfile" "$keyfile" true + else + /usr/local/bin/ssl-check-generate.sh "$certfile" "$keyfile" false + fi +fi + +printf '{ + "certfile": "%s", + "keyfile": "%s", + "port": "%s", + "protocol": "%s", + "ssl": %s, + "ingress_user": "%s" +}' "$certfile" "$keyfile" "$nginx_port" "$service_protocol" "$(jq -r '.ssl' $OPTIONS_SOURCE)" "$ingress_user" \ + | tempio \ + -template /etc/nginx/templates/direct.gtpl \ + -out /etc/nginx/servers/direct.conf diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/type b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/type new file mode 100644 index 000000000..3d92b15f2 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/type @@ -0,0 +1 @@ +oneshot \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/up b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/up new file mode 100644 index 000000000..60ba159c2 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/init-nginx/up @@ -0,0 +1 @@ +/etc/s6-overlay/s6-rc.d/init-nginx/run \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/dependencies.d/init-folders b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/dependencies.d/init-folders new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/run b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/run index e13702a2e..5f5a1108b 100644 --- a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/run +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/run @@ -1,21 +1,148 @@ -#!/command/with-contenv bashio +#!/bin/bash # shellcheck shell=bash -set -e +set -euo pipefail -EXTENSIONS_DIR="${CHROME_EXTENSIONS_DIR:-/usr/src/chrome/extensions}" +############################ +# Configurable directories # +############################ -extensions=() -for extension in "${EXTENSIONS_DIR}/i-dont-care-about-cookies" "${EXTENSIONS_DIR}/ublock-origin"; do - if [ -d "$extension" ]; then - extensions+=("$extension") +CHROME_CACHE_DIR="/data/cache" +CHROME_PROFILE_DIR="/data/chrome-profile" +EXT_BASE_DIR="/data/extensions" + +# Extension IDs (Chrome Web Store) +# uBlock Origin (MV2): cjpalhdlnbpafiamejdnhcphjbkeiagm +# I don't care about cookies: fihnjjcciajhdojfnbdddfaoknhalnja +UBLOCK_ID="cjpalhdlnbpafiamejdnhcphjbkeiagm" +IDCAC_ID="fihnjjcciajhdojfnbdddfaoknhalnja" + +UBLOCK_DIR="${EXT_BASE_DIR}/ublock" +IDCAC_DIR="${EXT_BASE_DIR}/idontcareaboutcookies" + +################################# +# Ensure persistent writable FS # +################################# + +mkdir -p "$CHROME_CACHE_DIR" "$CHROME_PROFILE_DIR" "$EXT_BASE_DIR" +chown -R chrome:chrome "$CHROME_CACHE_DIR" "$CHROME_PROFILE_DIR" "$EXT_BASE_DIR" + +######################## +# Helper: download CRX # +######################## + +need_bin() { + local b="$1" + if ! command -v "$b" >/dev/null 2>&1; then + echo "Missing required binary: $b" + exit 1 fi -done +} -extension_flag="" -if [ ${#extensions[@]} -gt 0 ]; then - extension_flag="--load-extension=$(IFS=,; echo "${extensions[*]}")" -fi +crx_to_zip() { + # CRX2/CRX3 contains a header before the ZIP payload. + # We locate the first ZIP local-file header "PK\003\004" and write from there. + local crx="$1" + local zip="$2" + + python3 - "$crx" "$zip" <<'PY' +import sys + +crx_path, zip_path = sys.argv[1], sys.argv[2] +with open(crx_path, "rb") as f: + data = f.read() + +sig = b"PK\x03\x04" +i = data.find(sig) +if i == -1: + raise SystemExit("Could not find ZIP signature in CRX (PK\\x03\\x04).") + +with open(zip_path, "wb") as f: + f.write(data[i:]) +PY +} + +download_and_unpack_extension() { + local ext_id="$1" + local out_dir="$2" + local name="$3" + + # Skip if already unpacked + if [ -f "${out_dir}/manifest.json" ]; then + return 0 + fi + + need_bin python3 + need_bin curl + need_bin unzip + + mkdir -p "$out_dir" + chown -R chrome:chrome "$out_dir" + + local tmpdir + tmpdir="$(mktemp -d)" + # shellcheck disable=SC2064 + trap "rm -rf '$tmpdir'" EXIT + + local crx="${tmpdir}/${name}.crx" + local zip="${tmpdir}/${name}.zip" + + # CWS update endpoint (works for most public extensions) + # Note: prodversion is just a hint; keep it reasonably recent. + local url + url="https://clients2.google.com/service/update2/crx?response=redirect&prodversion=120.0.0.0&acceptformat=crx2,crx3&x=id%3D${ext_id}%26installsource%3Dondemand%26uc" + + echo "Downloading ${name} (${ext_id})..." + curl -fsSL "$url" -o "$crx" + + echo "Unpacking ${name}..." + crx_to_zip "$crx" "$zip" + + # Unzip into a clean directory + rm -rf "${out_dir:?}/"* + unzip -q "$zip" -d "$out_dir" + + chown -R chrome:chrome "$out_dir" + + # Basic validation + if [ ! -f "${out_dir}/manifest.json" ]; then + echo "Failed to unpack ${name}: manifest.json not found in ${out_dir}" + exit 1 + fi + + rm -rf "$tmpdir" + trap - EXIT +} + +######################### +# Download extensions # +######################### + +download_and_unpack_extension "$UBLOCK_ID" "$UBLOCK_DIR" "ublock-origin" +download_and_unpack_extension "$IDCAC_ID" "$IDCAC_DIR" "i-dont-care-about-cookies" + +EXTENSIONS="${UBLOCK_DIR},${IDCAC_DIR}" + +######################### +# Start Chromium # +######################### 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}" +# Use exec so s6 can manage the process; avoid backgrounding and /dev/null-ing +exec su chrome -c " + chromium-browser \ + --headless=new \ + --no-sandbox \ + --disable-gpu \ + --disable-dev-shm-usage \ + --disable-crash-reporter \ + --no-crash-upload \ + --hide-scrollbars \ + --remote-debugging-address=0.0.0.0 \ + --remote-debugging-port=9222 \ + --user-data-dir='${CHROME_PROFILE_DIR}' \ + --disk-cache-dir='${CHROME_CACHE_DIR}' \ + --disable-extensions-except='${EXTENSIONS}' \ + --load-extension='${EXTENSIONS}' \ + about:blank +" diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/type b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/type index 5883cff0c..1780f9f44 100644 --- a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/type +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/type @@ -1 +1 @@ -longrun +longrun \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/up b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/up new file mode 100644 index 000000000..ea0dde696 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-chrome/up @@ -0,0 +1 @@ +/etc/s6-overlay/s6-rc.d/svc-chrome/run \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/dependencies.d/init-folders b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/dependencies.d/init-folders new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/run b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/run index 9af8cd43d..a5e5681b3 100644 --- a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/run +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/run @@ -1,7 +1,12 @@ -#!/command/with-contenv bashio +#!/command/with-contenv bash # shellcheck shell=bash + set -e -mkdir -p "${MEILI_DIR}" +if [ ! -d "$MEILI_DIR" ]; then + mkdir -p "$MEILI_DIR" +fi -exec /bin/meilisearch --db-path "${MEILI_DIR}" --no-analytics --experimental-dumpless-upgrade +cd "$MEILI_DIR" + +exec /bin/meilisearch --no-analytics --experimental-dumpless-upgrade \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/type b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/type index 5883cff0c..1780f9f44 100644 --- a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/type +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/type @@ -1 +1 @@ -longrun +longrun \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/up b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/up new file mode 100644 index 000000000..a3be200b9 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-meilisearch/up @@ -0,0 +1 @@ +/etc/s6-overlay/s6-rc.d/svc-meilisearch/run \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/dependencies.d/init-nginx b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/dependencies.d/init-nginx new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/run b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/run new file mode 100644 index 000000000..96acd5752 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/run @@ -0,0 +1,9 @@ +#!/command/with-contenv bashio +# shellcheck shell=bash + +set -e + +bashio::net.wait_for "$SERVICE_PORT" localhost 900 + +bashio::log.info "Starting NGinx..." +exec nginx diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/type b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/type new file mode 100644 index 000000000..1780f9f44 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/type @@ -0,0 +1 @@ +longrun \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/up b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/up new file mode 100644 index 000000000..e0a24bcc0 --- /dev/null +++ b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/svc-nginx/up @@ -0,0 +1 @@ +/etc/s6-overlay/s6-rc.d/svc-nginx/run \ No newline at end of file diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/init-addon-config b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/init-addon-config new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/init-nginx b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/init-nginx new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/svc-nginx b/karakeep/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/svc-nginx new file mode 100644 index 000000000..e69de29bb diff --git a/karakeep/rootfs/usr/local/bin/ssl-check-generate.sh b/karakeep/rootfs/usr/local/bin/ssl-check-generate.sh new file mode 100644 index 000000000..d18267890 --- /dev/null +++ b/karakeep/rootfs/usr/local/bin/ssl-check-generate.sh @@ -0,0 +1,47 @@ +#!/command/with-contenv bashio +# shellcheck shell=bash + +set -e + +# Check for required arguments +if [ $# -ne 3 ]; then + bashio::log.error "[ssl-check-generate.sh] missing: " + exit 1 +fi + +bashio::log.debug "SSL Certificate check" + +renew_days=90 + +certfile="$1" +keyfile="$2" +selfsigned=${3:-true} + +if [ ! -f "$certfile" ] || [ ! -f "$keyfile" ]; then + if [ "$selfsigned" = "true" ]; then + /usr/local/bin/ssl-keygen.sh "$certfile" "$keyfile" + exit 0 + else + bashio::log.error "[ssl-check-generate.sh] either certfile, keyfile, or both are missing" + exit 1 + fi +fi + +enddate=$(openssl x509 -enddate -noout -in "$certfile" 2>/dev/null || true) +if [ -n "$enddate" ]; then + expiry_date=$(echo "$enddate" | cut -d= -f2 | sed 's/ GMT$//') + expiry_ts=$(date -d "$expiry_date" +%s) + now_ts=$(date +%s) + days_left=$(( (expiry_ts - now_ts) / 86400 )) + + if [ "$days_left" -le "$renew_days" ]; then + bashio::log.info "Self-signed cert expiring in $days_left days, regenerating..." + /usr/local/bin/ssl-keygen.sh "$certfile" "$keyfile" + fi +else + bashio::log.error "Unable to determine ssl certificate expiry date" +fi + +if pgrep -x nginx >/dev/null 2>&1; then + nginx -s reload +fi \ No newline at end of file diff --git a/karakeep/rootfs/usr/local/bin/ssl-keygen.sh b/karakeep/rootfs/usr/local/bin/ssl-keygen.sh new file mode 100644 index 000000000..da821340d --- /dev/null +++ b/karakeep/rootfs/usr/local/bin/ssl-keygen.sh @@ -0,0 +1,57 @@ +#!/command/with-contenv bashio +# shellcheck shell=bash + +set -e + +# Check for required arguments +if [ $# -ne 2 ]; then + bashio::log.error "[ssl-keygen.sh] missing: " + exit 1 +fi + +certfile="$1" +keyfile="$2" + +[ -f "$certfile" ] && rm -f "$certfile" +[ -f "$keyfile" ] && rm -f "$keyfile" + +mkdir -p "$(dirname "$certfile")" && mkdir -p "$(dirname "$keyfile")" + +if ! hostname="$(bashio::info.hostname 2> /dev/null)" || [ -z "$hostname" ]; then + hostname="homeassistant" +fi +tmp_openssl_cfg=$(mktemp) +trap 'rm -f "$tmp_openssl_cfg"' EXIT + +cat > "$tmp_openssl_cfg" <