Compare commits

..
Author SHA1 Message Date
Thomas Camlong 3dc382145c refactor(cli): rewrite CLI for reliability and better UX
Replace brocli framework with Node's built-in util.parseArgs and a
declarative command registry. The CLI no longer hangs after completing
because:
- DB connections are lazily created and explicitly closed
- Winston/Redis logging is excluded from the bundle entirely
- process.exit() is always called with proper exit codes

Additional improvements:
- Bundle size reduced from 5.3MB to 1.2MB (native drivers externalized)
- Proper column-aligned table output for list commands
- --json flag on list commands for scripting/automation
- Per-command --help with usage examples
- Execution timing shown on success
- Consistent exit codes (0=success, 1=error, 2=usage)
- Docker wrapper sets DISABLE_REDIS_LOGS and uses exec
2026-05-21 16:05:27 +02:00
Releases Homarr 48ef8eb6c0 chore(release): 1.61.1 [skip ci] 2026-05-18 19:45:44 +00:00
Austin e9142c0dbc fix(downloads-widget): increase name column default width ratio 2026-05-18 21:44:47 +02:00
Releases Homarr 4635c51fe1 chore(release): 1.61.0 [skip ci] 2026-05-08 20:06:52 +00:00
homarr-releases[bot] 5cc0f97aa2 chore(release): automatic release v1.61.0 2026-05-08 20:05:49 +00:00
homarr-renovate[bot] b581f9b11a chore(deps): update dependency @extractus/feed-extractor to v7.2.1 (#5670)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-08 19:26:12 +00:00
Meier Lukas 756e8d1724 feat(qbittorrent): add api-key support (#5677) 2026-05-08 20:08:37 +02:00
homarr-renovate[bot] 7c64de5cbc chore(deps): update turbo monorepo to ^2.9.8 (#5669)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-08 17:25:39 +00:00
Ashton BattyandMeier Lukas 56af6bcaf0 feat(docker): Podman compatibility, multi-socket support, per-host error isolation (#5425)
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-08 17:31:56 +02:00
homarr-renovate[bot] 84b269a80d chore(deps): update tanstack-query monorepo to ^5.100.9 (#5678)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-08 15:30:26 +00:00
Borislaw SotnikowandMeier Lukas 4d30a2e8c4 feat(installations): support secrets file for all environment variables (#5125)
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-08 17:11:08 +02:00
Meier Lukas 2d15b3d407 chore(deps): update dependency zod to v4.4.3 (#5675) 2026-05-08 17:10:22 +02:00
Manuel 44a2973b1a revert(deps): downgrade pnpm to v10 (#5673) 2026-05-08 16:03:12 +02:00
Manuel 00a055283e fix(qbittorrent): support version 5.2 (#5672) 2026-05-08 15:44:04 +02:00
Manuel a474dcd961 chore: exclude renovate managed files from codeowners (#5676) 2026-05-08 15:37:41 +02:00
homarr-update-contributors[bot] 69fe180968 chore: update contributors (#5674)
Co-authored-by: Homarr Update Contributors <210161987+homarr-update-contributors[bot]@users.noreply.github.com>
2026-05-08 13:25:53 +00:00
036f6aa185 chore(deps): update dependency recharts to v3 (#4302)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: Manuel <30572287+manuel-rw@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-08 15:02:52 +02:00
homarr-crowdin[bot]andMeier Lukas 12a1bd7e2e chore(lang): updated translations from crowdin
* chore(lang): update translations from crowdin

* chore(lang): update translations from crowdin

---------

Co-authored-by: Crowdin Homarr <190541745+homarr-crowdin[bot]@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-08 13:54:36 +02:00
homarr-renovate[bot] c4ec45a9d0 chore(deps): update pnpm to v11.0.4 (#5668)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-08 03:04:44 +00:00
homarr-renovate[bot]andMeier Lukas b8e0123893 chore(deps): update pnpm to v11 (#5660)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-07 22:46:55 +02:00
homarr-renovate[bot] df953771a7 chore(deps): update dependency axios@&gt;&#x3d;1.0.0 &lt;1.8.2 to >=1.16.0 (#5665)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-07 20:22:00 +00:00
44bd16d677 fix(calendar): keep working integrations when one fails (#5629)
Co-authored-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-07 22:02:21 +02:00
sharpsalatandsharpsalat 277a509f49 feat: add pwa support (#5530)
* feat: add pwa support

* fix: deepsource warning

* fix: format warning

* fix: lint error

---------

Co-authored-by: sharpsalat <deniska.xrenov23@yandex.ru>
2026-05-07 21:53:17 +02:00
homarr-crowdin[bot]andMeier Lukas a9ad991892 chore(lang): updated translations from crowdin (#5623)
Co-authored-by: Crowdin Homarr <190541745+homarr-crowdin[bot]@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-07 21:04:10 +02:00
Meier Lukas 3183914a15 fix(apps): creation on the fly broken (#5605) 2026-05-07 20:59:12 +02:00
Meier Lukas 62be81ea60 fix(lang): portuguese is linked to brazilian portuguese on crowdin (#5622) 2026-05-07 20:54:11 +02:00
Meier Lukas ffc292b22a ci: increase timeout of asset extraction due job cancellation
https://github.com/homarr-labs/homarr/actions/runs/25509168979/attempts/1
2026-05-07 18:48:13 +02:00
ThomasandMeier Lukas b5c316b825 feat(spotlight): rework !bang search UX (#4813)
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-07 18:38:40 +02:00
KyleandThomas 831b6221fd feat: add auto/system appearance mode + fix dark mode system resources charts (#5492)
Co-authored-by: Thomas <thomas@ajnart.fr>
2026-05-07 16:28:37 +00:00
homarr-update-contributors[bot] 37edfb2de2 chore: update integrations list readme (#5662)
Co-authored-by: Homarr Update Contributors <210161987+homarr-update-contributors[bot]@users.noreply.github.com>
2026-05-07 16:11:16 +00:00
43cc68bdd4 feat: add Umami Analytics integration and widget (#5362)
Co-authored-by: Josh G <febrile42@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
Co-authored-by: Thomas <thomas@ajnart.fr>
2026-05-07 17:50:58 +02:00
Meier Lukas 0937555d49 feat(entity-state): add data attributes for custom-css styling (#5655) 2026-05-07 16:54:57 +02:00
homarr-renovate[bot] 663fe980bf chore(deps): update dependency yaml to v2.8.4 (#5659)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-07 09:39:58 +00:00
homarr-renovate[bot] 9e2c487389 chore(deps): update dependency isomorphic-dompurify to ^3.12.0 (#5658)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-07 06:19:31 +00:00
homarr-renovate[bot] 698e551790 chore(deps): update tanstack-query monorepo to ^5.100.8 (#5657)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-07 06:18:42 +00:00
homarr-renovate[bot] 71e4526ad5 chore(deps): update dependency zod to ^4.4.2 (#5656)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-06 22:04:29 +00:00
Meier Lukas b07a4a0f3e fix(update-checker): hide prereleases on non-prerelease versions (#5645) 2026-05-06 21:23:14 +02:00
homarr-renovate[bot] 62a476a949 chore(deps): update dependency eslint to ^10.3.0 (#5652)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-06 16:35:25 +00:00
homarr-renovate[bot] 6671ac48f9 chore(deps): update tanstack-query monorepo to ^5.100.7 (#5651)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-06 09:30:45 +00:00
homarr-renovate[bot] 3c7a7615ba chore(deps): update dependency nanoid@&gt;&#x3d;4.0.0 &lt;5.0.9 to >=5.1.11 (#5648)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-06 06:13:36 +00:00
homarr-renovate[bot] 2f301bb56a chore(deps): update turbo monorepo to ^2.9.7 (#5649)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-06 03:01:59 +00:00
homarr-renovate[bot] e06abbc176 chore(deps): update dependency nanoid@&gt;&#x3d;4.0.0 &lt;5.0.9 to >=5.1.10 (#5646)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-05 21:10:38 +00:00
homarr-renovate[bot] 04daeba089 chore(deps): update dependency jsdom to ^29.1.1 (#5643)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-05 10:55:08 +00:00
homarr-renovate[bot] 7c83d2cb6e chore(deps): update dependency hono@&lt;4.6.5 to >=4.12.16 (#5642)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-05 10:54:29 +00:00
homarr-renovate[bot] 2829d145af chore(deps): update dependency zod to ^4.4.1 (#5641)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-05 02:56:52 +00:00
homarr-renovate[bot] 44bf36fff9 chore(deps): update dependency timezones-ical-library to ^2.2.0 (#5640)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-05 00:01:35 +00:00
homarr-renovate[bot] acd11c3fc1 chore(deps): update dependency isomorphic-dompurify to ^3.11.0 (#5638)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-04 16:53:37 +00:00
homarr-renovate[bot] b9c701a71b chore(deps): update dependency next-intl to v4.11.0 (#5635)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 19:08:04 +00:00
homarr-renovate[bot] e52ecd64ee chore(deps): update dependency next-intl to v4.10.1 (#5632)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 16:59:56 +00:00
homarr-renovate[bot] af77f729ec chore(deps): update tanstack-query monorepo to ^5.100.6 (#5633)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 16:59:30 +00:00
homarr-renovate[bot] 7c39e4de13 chore(deps): update dependency next-intl to v4.10.0 (#5631)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 15:56:23 +00:00
homarr-renovate[bot] 3e918e5d3d chore(deps): update dependency tsdav to ^2.2.0 (#5627)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 14:57:50 +00:00
homarr-renovate[bot] 9cd45f7832 chore(deps): update trpc monorepo to ^11.17.0 (#5630)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 13:19:32 +00:00
homarr-renovate[bot] 90ca3770a1 chore(deps): update tiptap monorepo to v3.22.5 (#5628)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-03 10:12:22 +00:00
homarr-renovate[bot]andMeier Lukas a183339063 chore(deps): update dependency eslint to v10 (#5038)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-02 21:41:16 +02:00
homarr-renovate[bot] 0a4e4c3b70 chore(deps): update dependency next-intl to v4.9.2 (#5625)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-02 19:07:29 +00:00
homarr-renovate[bot] b52e664d0f chore(deps): update dependency swagger-ui-react to ^5.32.5 (#5621)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-02 13:21:15 +00:00
homarr-renovate[bot] 9f4634a95d chore(deps): update dependency mysql2 to v3.22.3 (#5619)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-02 11:25:52 +00:00
homarr-renovate[bot] a6f6c2e945 chore(deps): update dependency jsdom to ^29.1.0 (#5620)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-05-02 02:53:35 +00:00
homarr-crowdin[bot]andMeier Lukas b6d23e7546 chore(lang): updated translations from crowdin
* chore(lang): update translations from crowdin

* chore(lang): update translations from crowdin

* chore(lang): update translations from crowdin

---------

Co-authored-by: Crowdin Homarr <190541745+homarr-crowdin[bot]@users.noreply.github.com>
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
2026-05-02 01:32:16 +00:00
Meier Lukas b0f2c94674 chore: update bug report template 2026-05-01 22:51:17 +02:00
homarr-releases[bot] 9cf0070442 chore: update bug report template (#5612)
Co-authored-by: Releases Homarr <175486441+homarr-releases[bot]@users.noreply.github.com>
2026-05-01 20:23:03 +00:00
Meier LukasandCopilot 647afbe2cb ci: add beta release workflow (#5601)
Co-authored-by: Copilot <copilot@github.com>
2026-05-01 22:20:58 +02:00
Releases Homarr e31555776e chore(release): 1.60.0 [skip ci] 2026-05-01 20:12:31 +00:00
homarr-releases[bot] 3c88ae9023 chore(release): automatic release v1.60.0 2026-05-01 20:11:31 +00:00
Meier Lukas 5200c17baf chore: retrigger release v1.60.0 2026-05-01 22:10:44 +02:00
Releases Homarr 97311b338a chore(release): 1.60.0 [skip ci] 2026-05-01 20:04:34 +00:00
homarr-releases[bot] a6b7e9df93 chore(release): automatic release v1.60.0 2026-05-01 20:03:37 +00:00
homarr-update-contributors[bot] e9289bd174 chore: update contributors (#5609)
Co-authored-by: Homarr Update Contributors <210161987+homarr-update-contributors[bot]@users.noreply.github.com>
2026-05-01 14:25:59 +00:00
Meier Lukas e8edc203b6 fix: migrate from node-cron to croner (#5407) 2026-05-01 16:21:38 +02:00
Meier Lukas ed6680ba6a perf(icons): updater takes 10 seconds to run with high cpu usage (#5608) 2026-05-01 16:21:22 +02:00
homarr-renovate[bot] 16c6929396 chore(deps): update tanstack-query monorepo to ^5.100.5 (#5606)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-04-30 19:30:50 +00:00
homarr-renovate[bot] dba9efc726 chore(deps): update tanstack-query monorepo to ^5.100.4 (#5603)
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
2026-04-30 17:53:27 +00:00
Meier Lukas ef012981db chore: replace app-id with client-id for actions/create-github-app-token due to deprecation (#5602) 2026-04-30 18:28:55 +02:00
Meier Lukas c24f4954ea ci: fix minor issues (#5604) 2026-04-30 18:27:57 +02:00
Meier Lukas a268fd5a26 chore(issue-template): fix issues for integration and widget template 2026-04-30 17:49:24 +02:00
201 changed files with 24374 additions and 4989 deletions

No files matched your search

+191
View File
@@ -0,0 +1,191 @@
---
description: Comprehensive Homarr codebase architecture and conventions reference
alwaysApply: true
---
# Homarr Codebase Context
Homarr is an open-source, self-hosted dashboard for managing homelab services. It integrates with 50+ self-hosted apps (media servers, download clients, DNS, NAS, etc.) and provides a drag-and-drop widget-based UI.
## Tech Stack
- **Monorepo**: pnpm workspaces + Turborepo
- **Framework**: Next.js (App Router, `output: "standalone"`) — T3 Stack
- **Language**: TypeScript throughout
- **ORM**: Drizzle (supports SQLite via better-sqlite3, MySQL, PostgreSQL)
- **API**: tRPC (HTTP + WebSocket subscriptions) with superjson + OpenAPI bridge via `trpc-to-openapi`
- **Auth**: NextAuth v5 (database sessions, Credentials/LDAP/OIDC providers)
- **UI**: Mantine v7 (not Tailwind) + Tabler icons
- **State**: Jotai (atoms), TanStack Query (server state via tRPC)
- **Realtime**: WebSocket server (`ws`) for tRPC subscriptions, backed by Redis pub/sub
- **Cron**: `node-cron` in a standalone Fastify service (`apps/tasks`)
- **i18n**: next-intl with `[locale]` dynamic segment (prefix mode: `"never"`, locale from cookie)
- **Testing**: Vitest + jsdom, Playwright for E2E
- **Package manager**: pnpm 10.33.2, Node >= 24.15.0
## Repository Structure
```
homarr/
├── apps/
│ ├── nextjs/ # Main Next.js application (port 3000)
│ ├── tasks/ # Cron job runner + Fastify tRPC API (port 3002)
│ └── websocket/ # Standalone tRPC WebSocket server (port 3001)
├── packages/
│ ├── api/ # tRPC appRouter, procedures, OpenAPI
│ ├── auth/ # NextAuth config, providers, session, API keys
│ ├── db/ # Drizzle schema (3 DB drivers), migrations, queries
│ ├── core/ # Env validation, DB/Redis driver factories, logging
│ ├── definitions/ # Domain enums: WidgetKind, IntegrationKind, permissions
│ ├── widgets/ # All 39 dashboard widgets (definitions + components)
│ ├── integrations/ # Integration classes (HTTP clients to external apps)
│ ├── redis/ # Redis pub/sub channels, caching abstractions
│ ├── translation/ # next-intl setup, locale configs, lang JSON files
│ ├── ui/ # Shared Mantine components, theme, hooks
│ ├── validation/ # Shared zod schemas for API/forms
│ ├── common/ # Shared utilities, IDs, errors
│ ├── cron-jobs/ # Cron job implementations (25+ jobs)
│ ├── cron-jobs-core/ # Cron scheduling primitives
│ ├── cron-job-api/ # tRPC router for job management (start/stop/trigger)
│ ├── cron-job-status/ # Cron status via Redis
│ ├── boards/ # Board context, edit mode, cache updater
│ ├── modals/ # Modal primitives on Mantine
│ ├── modals-collection/ # Feature modals (apps, boards, docker, etc.)
│ ├── form/ # useZodForm (Mantine + zod resolver)
│ ├── forms-collection/# Reusable form UIs (new app, icon picker, upload)
│ ├── spotlight/ # Command palette / search with multiple modes
│ ├── request-handler/ # Server request handlers (feeds, integrations)
│ ├── notifications/ # Mantine notifications wrapper
│ ├── docker/ # Dockerode-based Docker access
│ ├── icons/ # Icon DB/repo integration
│ ├── image-proxy/ # Image proxy + caching
│ ├── ping/ # Reachability / ping utilities
│ ├── analytics/ # Server-side analytics (Umami)
│ ├── server-settings/ # Server setting keys/types
│ ├── settings/ # User-facing settings UI context
│ ├── old-import/ # Legacy Homarr import
│ ├── old-schema/ # Legacy Homarr zod schemas
│ └── cli/ # Node CLI for ops (brocli)
├── tooling/
│ ├── eslint/ # Shared ESLint configs
│ ├── prettier/ # Shared Prettier config
│ ├── typescript/ # Base tsconfig
│ └── github/ # CI setup action
├── development/ # Dev docker-compose (Redis, MySQL, PostgreSQL)
├── e2e/ # E2E test specs
└── Dockerfile # Multi-stage production build
```
## Three Runtime Services
| Service | Port | Role |
|---------|------|------|
| Next.js | 3000 | Main web app (SSR + API routes) |
| WebSocket | 3001 | tRPC subscriptions via `ws` |
| Tasks | 3002 | Cron job runner + management API via Fastify |
In Docker, nginx listens on **7575** and proxies to all three. The tasks service authenticates via `CRON_JOB_API_KEY` header.
## Package Dependency Layers
1. **Foundation**: `core` (env, DB drivers, Redis client, logging) → no `@homarr` deps
2. **Domain**: `definitions` → `common` → `core`
3. **Data**: `db` → `core`, `definitions`, `common`
4. **Auth**: `auth` → `db`, `definitions`, `core`, `validation`
5. **Cross-cutting**: `translation`, `validation`, `redis`, `server-settings`
6. **Feature backends**: `integrations`, `request-handler`, `cron-jobs`, `docker`, `ping`
7. **API surface**: `api` → pulls in auth, db, redis, integrations, etc.
8. **UI stack**: `ui`, `modals`, `form`, `notifications`, `boards`, `spotlight`
9. **Composed features**: `widgets`, `modals-collection`, `forms-collection`
## Key Patterns
### tRPC
- **Server caller** (RSC): `import { api } from "@homarr/api/server"` → cached caller with auth context
- **Client hooks**: `import { clientApi } from "@homarr/api/client"` → React Query hooks
- **Router structure**: `packages/api/src/root.ts` defines top-level namespaces (`user`, `board`, `widget`, `integration`, `docker`, `kubernetes`, etc.)
- **Procedures**: `publicProcedure`, `protectedProcedure`, `permissionRequiredProcedure`, `onboardingProcedure`
- **WebSocket subscriptions**: Client uses `wsLink` when `type === "subscription"`, connects to port 3001
### Multi-Database Support
Drizzle schemas exist in three parallel implementations:
- `packages/db/schema/sqlite.ts`
- `packages/db/schema/mysql.ts`
- `packages/db/schema/postgresql.ts`
Selected at runtime via `DB_DRIVER` env (`better-sqlite3` | `mysql2` | `node-postgres`). Migrations are per-engine in `packages/db/migrations/{sqlite,mysql,postgresql}/`.
### Widget System
Widgets are registered in `packages/widgets/src/index.tsx` as `widgetImports` (must satisfy `Record<WidgetKind, ...>`). Each widget:
- Has a `definition` created via `createWidgetDefinition(kind, { icon, createOptions, supportedIntegrations? })`
- Uses `optionsBuilder.from(factory => ({ ... }))` for typed options
- Loads dynamically via `next/dynamic`
- Fetches data via tRPC client hooks (backed by cron job caches)
### Integration System
Integrations are defined in `packages/definitions/src/integration.ts` (`integrationDefs`) and instantiated via `createIntegrationAsync` in `packages/integrations/src/base/creator.ts`. Each extends abstract `Integration` class with `testConnectionAsync` and typed methods.
### Cron Job System
Jobs defined in `packages/cron-jobs/src/jobs/`. Each job:
- Uses `createCronJob` with a cron expression
- Publishes results to Redis channels
- Widget subscriptions consume those channels via tRPC subscriptions
- Job management (start/stop/trigger) via `cronJobApi` HTTP client to port 3002
### Modals
Created with `createModal(component).withOptions({ defaultTitle })` from `@homarr/modals`. Opened via `useModalAction(SomeModal)`. Feature modals live in `packages/modals-collection/`.
### Forms
`useZodForm` from `@homarr/form` wraps Mantine `useForm` with zod validation. Shared form UIs in `packages/forms-collection/`.
### Routing (App Router)
- `apps/nextjs/src/app/[locale]/` — all UI routes under locale segment
- Route groups: `(home)`, `(content)`, `(board)` — don't affect URLs
- Key routes: `boards/[name]`, `manage/...` (admin), `auth/login`, `init` (onboarding), `widgets/[kind]`
- Locale driven by cookie (no URL prefix)
### Auth Providers
Configured via `AUTH_PROVIDERS` env. Supports: `credentials` (local), `ldap`, `oidc`. Database sessions with httpOnly cookies. API key auth for programmatic access.
## Environment Variables
Key env vars (from `.env.example`):
- `DB_DRIVER`: `better-sqlite3` | `mysql2` | `node-postgres`
- `DB_URL`: Database connection string
- `AUTH_SECRET`: NextAuth secret
- `SECRET_ENCRYPTION_KEY`: AES-256-CBC for integration secrets
- `AUTH_PROVIDERS`: Comma-separated (`credentials`, `ldap`, `oidc`)
- `CRON_JOB_API_KEY`: Shared key between Next.js and tasks service
- `REDIS_*`: Redis connection (host, port, password)
- `ENABLE_KUBERNETES`: Optional Kubernetes integration
## Development Commands
- `pnpm dev` — runs all three services in parallel via Turborepo
- `pnpm docker:dev` — starts Redis + MySQL + PostgreSQL containers
- `pnpm db:push` — push schema to SQLite (dev)
- `pnpm db:studio` — Drizzle Studio
- `pnpm test` — Vitest unit tests
- `pnpm test:e2e` — Playwright E2E
- `pnpm lint` / `pnpm format` — ESLint + Prettier
- `pnpm typecheck` — tsc --noEmit across all packages
## Conventions
- Workspace packages use `@homarr/` scope
- All versions managed via pnpm `catalog:` in workspace
- Path alias `~/*` → `./src/*` in Next.js app
- Mantine for all UI (no Tailwind) — primary color is red, `autoContrast: true`
- Icons from `@tabler/icons-react`
- Drag-and-drop via `@dnd-kit/*`
- `typescript.ignoreBuildErrors: true` in next.config (types checked separately via `typecheck`)
- `serverExternalPackages`: `dockerode`, `isomorphic-dompurify`, `jsdom`
+10
View File
@@ -12,6 +12,10 @@ AUTH_SECRET="supersecret"
# or starting the project without any (which will show a randomly generated one). # or starting the project without any (which will show a randomly generated one).
SECRET_ENCRYPTION_KEY=0000000000000000000000000000000000000000000000000000000000000000 SECRET_ENCRYPTION_KEY=0000000000000000000000000000000000000000000000000000000000000000
# Cron job API key is generated every time the container starts as it is required for communication between nextjs-api and tasks-api
# export CRON_JOB_API_KEY=$(openssl rand -base64 32)
# CRON_JOB_API_KEY="your-generated-api-key"
LOG_LEVEL='info' LOG_LEVEL='info'
# This is how you can use the sqlite driver: # This is how you can use the sqlite driver:
@@ -41,6 +45,12 @@ DB_URL='FULL_PATH_TO_YOUR_SQLITE_DB_FILE'
TURBO_TELEMETRY_DISABLED=1 TURBO_TELEMETRY_DISABLED=1
# Comma-separated paths to Docker-compatible Unix sockets.
# Useful for connecting to multiple runtimes (Docker + Podman) simultaneously.
# When unset and no TCP hosts configured, defaults to /var/run/docker.sock.
# Example: DOCKER_SOCKET_PATHS=/var/run/docker.sock,/run/user/1000/podman/podman.sock
# DOCKER_SOCKET_PATHS=
# Enable kubernetes tool # Enable kubernetes tool
# ENABLE_KUBERNETES=true # ENABLE_KUBERNETES=true
+2
View File
@@ -33,6 +33,8 @@ body:
options: options:
# The below comment is used to insert a new version with on-release.yml # The below comment is used to insert a new version with on-release.yml
#NEXT_VERSION# #NEXT_VERSION#
- 1.60.1-beta.1
- 1.60.0
- 1.59.3 - 1.59.3
- 1.59.2 - 1.59.2
- 1.59.1 - 1.59.1
+5 -5
View File
@@ -25,16 +25,16 @@ body:
label: Public API available? label: Public API available?
description: Is there a public API available, that we can consume in Homarr? description: Is there a public API available, that we can consume in Homarr?
options: options:
- Yes, available on a website - "Yes, available on a website"
- Yes, available in the application itself - "Yes, available in the application itself"
- No - "No"
validations: validations:
required: true required: true
- type: dropdown - type: dropdown
attributes: attributes:
label: Are you willing to contribute this yourself? label: Are you willing to contribute this yourself?
options: options:
- Yes - "Yes"
- No - "No"
validations: validations:
required: true required: true
+2 -2
View File
@@ -24,7 +24,7 @@ body:
attributes: attributes:
label: Are you willing to contribute this yourself? label: Are you willing to contribute this yourself?
options: options:
- Yes - "Yes"
- No - "No"
validations: validations:
required: true required: true
+1 -1
View File
@@ -23,7 +23,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }} private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
app-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }} client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
permission-pull-requests: write # required to approve pull request permission-pull-requests: write # required to approve pull request
- name: Install GitHub CLI - name: Install GitHub CLI
+1 -1
View File
@@ -11,7 +11,7 @@ on:
concurrency: concurrency:
group: "${{ github.workflow }}-${{ github.ref }}" group: "${{ github.workflow }}-${{ github.ref }}"
cancel-in-progress: ${{ github.ref != 'refs/heads/master' }} cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
env: env:
FORCE_COLOR: 3 FORCE_COLOR: 3
@@ -22,7 +22,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.CROWDIN_APP_PRIVATE_KEY }} private-key: ${{ secrets.CROWDIN_APP_PRIVATE_KEY }}
app-id: ${{ secrets.CROWDIN_APP_ID }} client-id: ${{ secrets.CROWDIN_APP_ID }}
permission-contents: write # required to commit to crowdin branch permission-contents: write # required to commit to crowdin branch
permission-pull-requests: write # required to create pull request permission-pull-requests: write # required to create pull request
@@ -0,0 +1,104 @@
name: "[Deployment] Beta Release"
on:
workflow_dispatch:
inputs:
send-notifications:
type: boolean
required: false
default: true
description: Send notifications
permissions:
contents: write
pull-requests: write
jobs:
create-and-merge-pr:
runs-on: ubuntu-latest
timeout-minutes: 2
steps:
- name: Discord notification
if: ${{ github.event.inputs.send-notifications }}
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@0.4.0
with:
args: "Beta release has been triggered: [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})"
- name: Checkout repository
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Get Next Version
id: semver
uses: ietf-tools/semver-action@v1
with:
token: ${{ github.token }}
branch: next
- name: Create pull request
id: create-pull-request
run: 'gh pr create --title "chore(release): release ${{ steps.semver.outputs.next }}-beta" --body "Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}-beta``" --base beta --head next --label automerge'
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
- name: Discord notification
if: ${{ github.event.inputs.send-notifications }}
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@0.4.0
with:
args: "Created a release PR ${{ steps.create-pull-request.outputs.url }} for version ${{ steps.semver.outputs.next }}-beta (new behaviour: ${{ steps.semver.outputs.bump }})"
- name: Obtain token
id: obtainApprovalToken
uses: actions/create-github-app-token@v3
with:
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
permission-pull-requests: write
- name: Approve PR
env:
GITHUB_TOKEN: ${{ steps.obtainApprovalToken.outputs.token }}
run: |
gh pr review --approve --body "Automatically approved by GitHub Action"
- name: Obtain token
id: obtainMergeToken
uses: actions/create-github-app-token@v3
with:
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
permission-contents: write # write to beta branch (due to merge)
permission-pull-requests: write # merge pull request
- id: automerge
if: ${{ steps.semver.outputs.bump != 'major' }}
name: automerge
uses: "pascalgn/automerge-action@v0.16.4"
env:
GITHUB_TOKEN: ${{ steps.obtainMergeToken.outputs.token }}
MERGE_METHOD: merge # we prefer merge commits for merging to beta
MERGE_COMMIT_MESSAGE: "chore(release): release ${{ steps.semver.outputs.next }}-beta"
MERGE_DELETE_BRANCH: false # never set to true!
PULL_REQUEST: "${{ steps.create-pull-request.outputs.pr_number }}"
MERGE_RETRIES: 20 # 20 retries * MERGE_RETRY_SLEEP until step fails
MERGE_RETRY_SLEEP: 10000 # 10 seconds * MERGE_RETRIES until step fails
MERGE_REQUIRED_APPROVALS: 0 # do not require approvals
- name: Merged Discord notification
if: ${{ steps.automerge.outputs.mergeResult == 'merged' && github.event.inputs.send-notifications }}
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@0.4.0
with:
args: "Merged PR ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}-beta"
- name: Major Bump Discord notification
if: ${{ steps.semver.outputs.bump == 'major' && github.event.inputs.send-notifications }}
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@0.4.0
with:
args: "The release PR must be manually merged because the next version is a major version: ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}-beta"
- name: Discord Fail Notification
if: failure() && github.event.inputs.send-notifications
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@0.4.0
with:
args: "The beta release workflow [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) has failed"
@@ -53,7 +53,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }} private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }} client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
permission-contents: write # required to commit package.json & changelog changes, merge them to dev and publish the release permission-contents: write # required to commit package.json & changelog changes, merge them to dev and publish the release
- uses: actions/checkout@v6 - uses: actions/checkout@v6
@@ -191,7 +191,7 @@ jobs:
name: Extract amd64 asset from docker image name: Extract amd64 asset from docker image
needs: [release, build-amd64] needs: [release, build-amd64]
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 2 timeout-minutes: 5
steps: steps:
- name: Extract amd64 - name: Extract amd64
if: needs.release.outputs.skipped == 'false' if: needs.release.outputs.skipped == 'false'
@@ -207,7 +207,7 @@ jobs:
name: Extract arm64 asset from docker image name: Extract arm64 asset from docker image
needs: [release, build-arm64] needs: [release, build-arm64]
runs-on: ubuntu-24.04-arm runs-on: ubuntu-24.04-arm
timeout-minutes: 2 timeout-minutes: 5
steps: steps:
- name: Extract arm64 - name: Extract arm64
if: needs.release.outputs.skipped == 'false' if: needs.release.outputs.skipped == 'false'
@@ -234,7 +234,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }} private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }} client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
permission-contents: write # required to publish the release permission-contents: write # required to publish the release
- name: Log in to the Container registry - name: Log in to the Container registry
@@ -274,6 +274,6 @@ jobs:
- name: Discord notification - name: Discord notification
env: env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@master uses: Ilshidur/action-discord@0.4.0
with: with:
args: "Successfully deployed images for branch **${{ github.ref_name }}**. Tagged as **${{env.NEXT_VERSION}}**." args: "Successfully deployed images for branch **${{ github.ref_name }}**. Tagged as **${{env.NEXT_VERSION}}**."
+14 -13
View File
@@ -21,10 +21,10 @@ jobs:
timeout-minutes: 2 timeout-minutes: 2
steps: steps:
- name: Discord notification - name: Discord notification
if: ${{ github.events.inputs.send-notifications }} if: ${{ github.event.inputs.send-notifications }}
env: env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@master uses: Ilshidur/action-discord@0.4.0
with: with:
args: "Automatic release has been triggered: [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})" args: "Automatic release has been triggered: [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})"
- name: Checkout repository - name: Checkout repository
@@ -38,14 +38,15 @@ jobs:
token: ${{ github.token }} token: ${{ github.token }}
branch: dev branch: dev
- name: Create pull request - name: Create pull request
id: create-pull-request
run: 'gh pr create --title "chore(release): automatic release ${{ steps.semver.outputs.next }}" --body "**This is an automatic release**.<br/>Manual action may be required for major bumps.<br/>Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}``" --base main --head dev --label automerge' run: 'gh pr create --title "chore(release): automatic release ${{ steps.semver.outputs.next }}" --body "**This is an automatic release**.<br/>Manual action may be required for major bumps.<br/>Detected change to be ``${{ steps.semver.outputs.bump }}``<br/>Bump version from ``${{ steps.semver.outputs.current }}`` to ``${{ steps.semver.outputs.next }}``" --base main --head dev --label automerge'
env: env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
- name: Discord notification - name: Discord notification
if: ${{ github.events.inputs.send-notifications }} if: ${{ github.event.inputs.send-notifications }}
env: env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@master uses: Ilshidur/action-discord@0.4.0
with: with:
args: "Created a release PR ${{ steps.create-pull-request.outputs.url }} for version ${{ steps.semver.outputs.next }} (new behaviour: ${{ steps.semver.outputs.bump }})" args: "Created a release PR ${{ steps.create-pull-request.outputs.url }} for version ${{ steps.semver.outputs.next }} (new behaviour: ${{ steps.semver.outputs.bump }})"
- name: Obtain token - name: Obtain token
@@ -53,7 +54,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }} private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
app-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }} client-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
permission-pull-requests: write permission-pull-requests: write
- name: Approve PR - name: Approve PR
env: env:
@@ -65,7 +66,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }} private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }} client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
permission-contents: write # write to main branch (due to merge) permission-contents: write # write to main branch (due to merge)
permission-pull-requests: write # merge pull request permission-pull-requests: write # merge pull request
- id: automerge - id: automerge
@@ -74,7 +75,7 @@ jobs:
uses: "pascalgn/automerge-action@v0.16.4" uses: "pascalgn/automerge-action@v0.16.4"
env: env:
GITHUB_TOKEN: ${{ steps.obtainMergeToken.outputs.token }} GITHUB_TOKEN: ${{ steps.obtainMergeToken.outputs.token }}
MERGE_METHOD: merge # we prefer merge commits for merging to master MERGE_METHOD: merge # we prefer merge commits for merging to main
MERGE_COMMIT_MESSAGE: "chore(release): automatic release ${{ steps.semver.outputs.next }}" MERGE_COMMIT_MESSAGE: "chore(release): automatic release ${{ steps.semver.outputs.next }}"
MERGE_DELETE_BRANCH: false # never set to true! MERGE_DELETE_BRANCH: false # never set to true!
PULL_REQUEST: "${{ steps.create-pull-request.outputs.pr_number }}" PULL_REQUEST: "${{ steps.create-pull-request.outputs.pr_number }}"
@@ -83,23 +84,23 @@ jobs:
MERGE_REQUIRED_APPROVALS: 0 # do not require approvals MERGE_REQUIRED_APPROVALS: 0 # do not require approvals
- name: Merged Discord notification - name: Merged Discord notification
if: ${{ steps.automerge.outputs.mergeResult == 'merged' && github.events.inputs.send-notifications }} if: ${{ steps.automerge.outputs.mergeResult == 'merged' && github.event.inputs.send-notifications }}
env: env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@master uses: Ilshidur/action-discord@0.4.0
with: with:
args: "Merged PR ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}" args: "Merged PR ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}"
- name: Major Bump Discord notification - name: Major Bump Discord notification
if: ${{ steps.semver.outputs.bump == 'major' && github.events.inputs.send-notifications }} if: ${{ steps.semver.outputs.bump == 'major' && github.event.inputs.send-notifications }}
env: env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@master uses: Ilshidur/action-discord@0.4.0
with: with:
args: "The release PR must be manually merged because the next version is a major version: ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}" args: "The release PR must be manually merged because the next version is a major version: ${{ steps.create-pull-request.outputs.url }} for release ${{ steps.semver.outputs.next }}"
- name: Discord Fail Notification - name: Discord Fail Notification
if: failure() && github.events.inputs.send-notifications if: failure() && github.event.inputs.send-notifications
env: env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
uses: Ilshidur/action-discord@master uses: Ilshidur/action-discord@0.4.0
with: with:
args: "The automatic release workflow [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) has failed" args: "The automatic release workflow [run ${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) has failed"
+2 -2
View File
@@ -15,7 +15,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.HOMARR_DOCS_RELEASE_APP_PRIVATE_KEY }} private-key: ${{ secrets.HOMARR_DOCS_RELEASE_APP_PRIVATE_KEY }}
app-id: ${{ vars.HOMARR_DOCS_RELEASE_APP_ID }} client-id: ${{ vars.HOMARR_DOCS_RELEASE_APP_ID }}
owner: homarr-labs owner: homarr-labs
repositories: | repositories: |
documentation documentation
@@ -48,7 +48,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }} private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }} client-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
permission-contents: write # required to commit to branch permission-contents: write # required to commit to branch
permission-pull-requests: write # required to create pr & enable automerge permission-pull-requests: write # required to create pr & enable automerge
- name: Checkout code - name: Checkout code
+1 -1
View File
@@ -24,7 +24,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }} private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }}
app-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }} client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
permission-contents: write # required to commit to branch permission-contents: write # required to commit to branch
permission-pull-requests: write # required to create pr & enable automerge permission-pull-requests: write # required to create pr & enable automerge
@@ -24,7 +24,7 @@ jobs:
uses: actions/create-github-app-token@v3 uses: actions/create-github-app-token@v3
with: with:
private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }} private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }}
app-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }} client-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
permission-contents: write # required to commit to branch permission-contents: write # required to commit to branch
permission-pull-requests: write # required to create pr & enable automerge permission-pull-requests: write # required to create pr & enable automerge
- name: Checkout code - name: Checkout code
+61
View File
@@ -1,3 +1,64 @@
## [1.61.1](https://github.com/homarr-labs/homarr/compare/v1.61.0...v1.61.1) (2026-05-18)
### Bug Fixes
* **downloads-widget:** increase name column default width ratio ([e9142c0](https://github.com/homarr-labs/homarr/commit/e9142c0dbcaca6cd9215b5292a2d139d96919b51))
## [1.61.0](https://github.com/homarr-labs/homarr/compare/v1.60.0...v1.61.0) (2026-05-08)
### Features
* add auto/system appearance mode + fix dark mode system resources charts ([#5492](https://github.com/homarr-labs/homarr/issues/5492)) ([831b622](https://github.com/homarr-labs/homarr/commit/831b6221fdf21fe4913b0f165ef551afeada4f33))
* add pwa support ([#5530](https://github.com/homarr-labs/homarr/issues/5530)) ([277a509](https://github.com/homarr-labs/homarr/commit/277a509f490d57bb6547c86c417c29c0e7af7e40))
* add Umami Analytics integration and widget ([#5362](https://github.com/homarr-labs/homarr/issues/5362)) ([43cc68b](https://github.com/homarr-labs/homarr/commit/43cc68bdd49c4877012e39e23355f6506aea7f4e))
* **docker:** Podman compatibility, multi-socket support, per-host error isolation ([#5425](https://github.com/homarr-labs/homarr/issues/5425)) ([56af6bc](https://github.com/homarr-labs/homarr/commit/56af6bcaf00e980e4c7a40d8e912901cd1395f5a))
* **entity-state:** add data attributes for custom-css styling ([#5655](https://github.com/homarr-labs/homarr/issues/5655)) ([0937555](https://github.com/homarr-labs/homarr/commit/0937555d49c29455bc33307ae5e50bf5b812c7c7))
* **installations:** support secrets file for all environment variables ([#5125](https://github.com/homarr-labs/homarr/issues/5125)) ([4d30a2e](https://github.com/homarr-labs/homarr/commit/4d30a2e8c48f818bb4947a651b0fec5f64cbf569))
* **qbittorrent:** add api-key support ([#5677](https://github.com/homarr-labs/homarr/issues/5677)) ([756e8d1](https://github.com/homarr-labs/homarr/commit/756e8d172455f91e40cd8fb5faff6953cc9778c5))
* **spotlight:** rework !bang search UX ([#4813](https://github.com/homarr-labs/homarr/issues/4813)) ([b5c316b](https://github.com/homarr-labs/homarr/commit/b5c316b825bdffa267fd173a3c39a12269142665))
### Bug Fixes
* **apps:** creation on the fly broken ([#5605](https://github.com/homarr-labs/homarr/issues/5605)) ([3183914](https://github.com/homarr-labs/homarr/commit/3183914a1502555681b73975062ed6ca8a48cb75))
* **calendar:** keep working integrations when one fails ([#5629](https://github.com/homarr-labs/homarr/issues/5629)) ([44bd16d](https://github.com/homarr-labs/homarr/commit/44bd16d6770d289054df6c7c93adff42d2243252))
* **lang:** portuguese is linked to brazilian portuguese on crowdin ([#5622](https://github.com/homarr-labs/homarr/issues/5622)) ([62be81e](https://github.com/homarr-labs/homarr/commit/62be81ea607a609a816157686700c54540e1568b))
* **qbittorrent:** support version 5.2 ([#5672](https://github.com/homarr-labs/homarr/issues/5672)) ([00a0552](https://github.com/homarr-labs/homarr/commit/00a055283e8848542b67d88a656a99fdd0bcb444))
* **update-checker:** hide prereleases on non-prerelease versions ([#5645](https://github.com/homarr-labs/homarr/issues/5645)) ([b07a4a0](https://github.com/homarr-labs/homarr/commit/b07a4a0f3e3af384ec477bf5c505a705b003de47))
### Reverts
* **deps:** downgrade pnpm to v10 ([#5673](https://github.com/homarr-labs/homarr/issues/5673)) ([44a2973](https://github.com/homarr-labs/homarr/commit/44a2973b1aba1e2c6bd818be022205f3cdb7c943))
## [1.60.0](https://github.com/homarr-labs/homarr/compare/v1.59.3...v1.60.0) (2026-05-01)
### Features
* **about:** add opencollective contributors ([#5481](https://github.com/homarr-labs/homarr/issues/5481)) ([3d202d4](https://github.com/homarr-labs/homarr/commit/3d202d409febf33d0218b589c979744c84f87407))
### Bug Fixes
* migrate from node-cron to croner ([#5407](https://github.com/homarr-labs/homarr/issues/5407)) ([e8edc20](https://github.com/homarr-labs/homarr/commit/e8edc203b6c862141668b043ef4232c22b8fae24))
* **openapi:** openapi document empty ([#5579](https://github.com/homarr-labs/homarr/issues/5579)) ([ce8e330](https://github.com/homarr-labs/homarr/commit/ce8e330c82bc0be9f299f3071a1e80daafc5f789))
### Performance Improvements
* **icons:** updater takes 10 seconds to run with high cpu usage ([#5608](https://github.com/homarr-labs/homarr/issues/5608)) ([ed6680b](https://github.com/homarr-labs/homarr/commit/ed6680ba6a42864185818eb8d90b2303846c1761))
## [1.60.0](https://github.com/homarr-labs/homarr/compare/v1.59.3...v1.60.0) (2026-05-01)
### Features
* **about:** add opencollective contributors ([#5481](https://github.com/homarr-labs/homarr/issues/5481)) ([3d202d4](https://github.com/homarr-labs/homarr/commit/3d202d409febf33d0218b589c979744c84f87407))
### Bug Fixes
* migrate from node-cron to croner ([#5407](https://github.com/homarr-labs/homarr/issues/5407)) ([e8edc20](https://github.com/homarr-labs/homarr/commit/e8edc203b6c862141668b043ef4232c22b8fae24))
* **openapi:** openapi document empty ([#5579](https://github.com/homarr-labs/homarr/issues/5579)) ([ce8e330](https://github.com/homarr-labs/homarr/commit/ce8e330c82bc0be9f299f3071a1e80daafc5f789))
### Performance Improvements
* **icons:** updater takes 10 seconds to run with high cpu usage ([#5608](https://github.com/homarr-labs/homarr/issues/5608)) ([ed6680b](https://github.com/homarr-labs/homarr/commit/ed6680ba6a42864185818eb8d90b2303846c1761))
## [1.59.3](https://github.com/homarr-labs/homarr/compare/v1.59.2...v1.59.3) (2026-04-24) ## [1.59.3](https://github.com/homarr-labs/homarr/compare/v1.59.2...v1.59.3) (2026-04-24)
### Bug Fixes ### Bug Fixes
+4
View File
@@ -3,7 +3,11 @@
# Exempt Renovate‑managed files (no owners) # Exempt Renovate‑managed files (no owners)
package.json package.json
**/package.json
package-lock.json package-lock.json
**/package-lock.json
pnpm-lock.yaml pnpm-lock.yaml
**/pnpm-lock.yaml
pnpm-workspace.yaml
Dockerfile Dockerfile
docker-compose.yml docker-compose.yml
+3 -1
View File
@@ -30,7 +30,7 @@ VOLUME /appdata
# Enable homarr cli # Enable homarr cli
COPY --from=builder /app/packages/cli/cli.cjs /app/apps/cli/cli.cjs COPY --from=builder /app/packages/cli/cli.cjs /app/apps/cli/cli.cjs
RUN echo $'#!/bin/bash\ncd /app/apps/cli && node ./cli.cjs "$@"' > /usr/bin/homarr RUN echo $'#!/bin/bash\nexport DISABLE_REDIS_LOGS=true\ncd /app/apps/cli && exec node ./cli.cjs "$@"' > /usr/bin/homarr
RUN chmod +x /usr/bin/homarr RUN chmod +x /usr/bin/homarr
# Don't run production as root # Don't run production as root
@@ -43,6 +43,8 @@ RUN mkdir -p /var/cache/nginx && \
COPY --from=builder /app/apps/nextjs/next.config.ts . COPY --from=builder /app/apps/nextjs/next.config.ts .
COPY --from=builder /app/apps/nextjs/package.json . COPY --from=builder /app/apps/nextjs/package.json .
COPY --from=builder /app/apps/tasks/tasks.cjs ./apps/tasks/tasks.cjs
COPY --from=builder /app/apps/websocket/wssServer.cjs ./apps/websocket/wssServer.cjs
COPY --from=builder /app/node_modules/better-sqlite3/build/Release/better_sqlite3.node /app/build/better_sqlite3.node COPY --from=builder /app/node_modules/better-sqlite3/build/Release/better_sqlite3.node /app/build/better_sqlite3.node
COPY --from=builder /app/packages/db/migrations ./db/migrations COPY --from=builder /app/packages/db/migrations ./db/migrations
+17
View File
@@ -10,4 +10,21 @@ export default [
...baseConfig, ...baseConfig,
...reactConfig, ...reactConfig,
...nextjsConfig, ...nextjsConfig,
{
files: ["public/sw.js"],
languageOptions: {
globals: {
self: "readonly",
clients: "readonly",
skipWaiting: "readonly",
importScripts: "readonly",
caches: "readonly",
fetch: "readonly",
},
},
rules: {
"@typescript-eslint/no-unsafe-call": "off",
"@typescript-eslint/no-unsafe-member-access": "off",
},
},
]; ];
+9
View File
@@ -42,9 +42,18 @@ const nextConfig: NextConfig = {
}, },
], ],
}, },
// skipcq: JS-0116
// eslint-disable-next-line @typescript-eslint/require-await,no-restricted-syntax // eslint-disable-next-line @typescript-eslint/require-await,no-restricted-syntax
async headers() { async headers() {
return [ return [
{
source: "/sw.js",
headers: [
{ key: "Content-Type", value: "application/javascript; charset=utf-8" },
{ key: "Cache-Control", value: "no-cache, no-store, must-revalidate" },
{ key: "Content-Security-Policy", value: "default-src 'self'; script-src 'self'" },
],
},
{ {
source: "/(.*)", // Apply CSP to all routes source: "/(.*)", // Apply CSP to all routes
headers: [ headers: [
-2
View File
@@ -44,11 +44,9 @@
"@homarr/server-settings": "workspace:^0.1.0", "@homarr/server-settings": "workspace:^0.1.0",
"@homarr/settings": "workspace:^0.1.0", "@homarr/settings": "workspace:^0.1.0",
"@homarr/spotlight": "workspace:^0.1.0", "@homarr/spotlight": "workspace:^0.1.0",
"@homarr/tasks": "workspace:^0.1.0",
"@homarr/translation": "workspace:^0.1.0", "@homarr/translation": "workspace:^0.1.0",
"@homarr/ui": "workspace:^0.1.0", "@homarr/ui": "workspace:^0.1.0",
"@homarr/validation": "workspace:^0.1.0", "@homarr/validation": "workspace:^0.1.0",
"@homarr/websocket": "workspace:^0.1.0",
"@homarr/widgets": "workspace:^0.1.0", "@homarr/widgets": "workspace:^0.1.0",
"@mantine/colors-generator": "catalog:", "@mantine/colors-generator": "catalog:",
"@mantine/core": "catalog:", "@mantine/core": "catalog:",
+7
View File
@@ -0,0 +1,7 @@
self.addEventListener("install", () => {
self.skipWaiting();
});
self.addEventListener("activate", (event) => {
event.waitUntil(self.clients.claim());
});
@@ -8,13 +8,12 @@ import dayjs from "dayjs";
import { clientApi } from "@homarr/api/client"; import { clientApi } from "@homarr/api/client";
import { useSession } from "@homarr/auth/client"; import { useSession } from "@homarr/auth/client";
import { parseCookies, setClientCookie } from "@homarr/common"; import { parseCookies, setClientCookie } from "@homarr/common";
import type { ColorScheme } from "@homarr/definitions";
import { colorSchemeCookieKey } from "@homarr/definitions"; import { colorSchemeCookieKey } from "@homarr/definitions";
export const CustomMantineProvider = ({ export const CustomMantineProvider = ({
children, children,
defaultColorScheme, defaultColorScheme,
}: PropsWithChildren<{ defaultColorScheme: ColorScheme }>) => { }: PropsWithChildren<{ defaultColorScheme: MantineColorScheme }>) => {
const manager = useColorSchemeManager(); const manager = useColorSchemeManager();
return ( return (
<DirectionProvider> <DirectionProvider>
@@ -35,7 +34,7 @@ export const CustomMantineProvider = ({
export function useColorSchemeManager(): MantineColorSchemeManager { export function useColorSchemeManager(): MantineColorSchemeManager {
const { data: session } = useSession(); const { data: session } = useSession();
const updateCookieValue = (value: Exclude<MantineColorScheme, "auto">) => { const updateCookieValue = (value: MantineColorScheme) => {
setClientCookie(colorSchemeCookieKey, value, { expires: dayjs().add(1, "year").toDate(), path: "/" }); setClientCookie(colorSchemeCookieKey, value, { expires: dayjs().add(1, "year").toDate(), path: "/" });
}; };
@@ -60,7 +59,6 @@ export function useColorSchemeManager(): MantineColorSchemeManager {
}, },
set: (value) => { set: (value) => {
if (value === "auto") return;
try { try {
if (session) { if (session) {
mutateColorScheme({ colorScheme: value }); mutateColorScheme({ colorScheme: value });
+4 -1
View File
@@ -4,6 +4,7 @@ import { Inter } from "next/font/google";
import "@homarr/notifications/styles.css"; import "@homarr/notifications/styles.css";
import "@homarr/spotlight/styles.css"; import "@homarr/spotlight/styles.css";
import "@homarr/ui/styles.css"; import "@homarr/ui/styles.css";
import "~/styles/color-scheme.scss";
import "~/styles/scroll-area.scss"; import "~/styles/scroll-area.scss";
import { notFound } from "next/navigation"; import { notFound } from "next/navigation";
@@ -25,6 +26,7 @@ import { isLocaleRTL, isLocaleSupported } from "@homarr/translation";
import { Analytics } from "~/components/layout/analytics"; import { Analytics } from "~/components/layout/analytics";
import { CrowdinLiveTranslation } from "~/components/layout/crowdin-live-translation"; import { CrowdinLiveTranslation } from "~/components/layout/crowdin-live-translation";
import { SearchEngineOptimization } from "~/components/layout/search-engine-optimization"; import { SearchEngineOptimization } from "~/components/layout/search-engine-optimization";
import { ServiceWorkerRegistration } from "~/components/layout/service-worker-registration";
import { getCurrentColorSchemeAsync } from "~/theme/color-scheme"; import { getCurrentColorSchemeAsync } from "~/theme/color-scheme";
import { DayJsLoader } from "./_client-providers/dayjs-loader"; import { DayJsLoader } from "./_client-providers/dayjs-loader";
import { JotaiProvider } from "./_client-providers/jotai"; import { JotaiProvider } from "./_client-providers/jotai";
@@ -129,7 +131,7 @@ export default async function Layout(props: {
dir={direction} dir={direction}
data-mantine-color-scheme={colorScheme} data-mantine-color-scheme={colorScheme}
style={{ style={{
backgroundColor: colorScheme === "dark" ? "#242424" : "#fff", backgroundColor: colorScheme === "dark" ? "#242424" : colorScheme === "auto" ? undefined : "#fff",
}} }}
suppressHydrationWarning suppressHydrationWarning
> >
@@ -141,6 +143,7 @@ export default async function Layout(props: {
<body className={["font-sans", fontSans.variable].join(" ")}> <body className={["font-sans", fontSans.variable].join(" ")}>
<StackedProvider> <StackedProvider>
<Notifications /> <Notifications />
<ServiceWorkerRegistration />
{props.children} {props.children}
</StackedProvider> </StackedProvider>
</body> </body>
@@ -1,7 +1,7 @@
"use client"; "use client";
import { Group, Text } from "@mantine/core"; import { Group, Text } from "@mantine/core";
import { IconMoon, IconSun } from "@tabler/icons-react"; import { IconDeviceDesktop, IconMoon, IconSun } from "@tabler/icons-react";
import type { ColorScheme } from "@homarr/definitions"; import type { ColorScheme } from "@homarr/definitions";
import { colorSchemes } from "@homarr/definitions"; import { colorSchemes } from "@homarr/definitions";
@@ -34,6 +34,7 @@ export const AppearanceSettingsForm = ({ defaultValues }: { defaultValues: Serve
}; };
const appearanceIcons = { const appearanceIcons = {
auto: IconDeviceDesktop,
light: IconSun, light: IconSun,
dark: IconMoon, dark: IconMoon,
}; };
@@ -58,6 +58,18 @@ const createColumns = (
return <ContainerStateBadge state={cell.row.original.state} />; return <ContainerStateBadge state={cell.row.original.state} />;
}, },
}, },
{
accessorKey: "host",
header: t("docker.field.host.label"),
size: 140,
Cell({ row }) {
return (
<Text truncate="end" title={row.original.host}>
{row.original.host}
</Text>
);
},
},
{ {
accessorKey: "image", accessorKey: "image",
header: t("docker.field.containerImage.label"), header: t("docker.field.containerImage.label"),
@@ -26,6 +26,7 @@ export const ChangeSearchPreferencesForm = ({ user, searchEnginesData }: ChangeS
form.setInitialValues({ form.setInitialValues({
defaultSearchEngineId: variables.defaultSearchEngineId, defaultSearchEngineId: variables.defaultSearchEngineId,
openInNewTab: variables.openInNewTab, openInNewTab: variables.openInNewTab,
ddgBangsEnabled: variables.ddgBangsEnabled,
}); });
showSuccessNotification({ showSuccessNotification({
message: t("user.action.changeSearchPreferences.notification.success.message"), message: t("user.action.changeSearchPreferences.notification.success.message"),
@@ -41,6 +42,7 @@ export const ChangeSearchPreferencesForm = ({ user, searchEnginesData }: ChangeS
initialValues: { initialValues: {
defaultSearchEngineId: user.defaultSearchEngineId, defaultSearchEngineId: user.defaultSearchEngineId,
openInNewTab: user.openSearchInNewTab, openInNewTab: user.openSearchInNewTab,
ddgBangsEnabled: user.ddgBangs,
}, },
}); });
@@ -64,6 +66,10 @@ export const ChangeSearchPreferencesForm = ({ user, searchEnginesData }: ChangeS
label={t("user.field.openSearchInNewTab.label")} label={t("user.field.openSearchInNewTab.label")}
{...form.getInputProps("openInNewTab", { type: "checkbox" })} {...form.getInputProps("openInNewTab", { type: "checkbox" })}
/> />
<Switch
label={t("user.field.ddgBangs.label")}
{...form.getInputProps("ddgBangsEnabled", { type: "checkbox" })}
/>
<Group justify="end"> <Group justify="end">
<Button type="submit" loading={isPending}> <Button type="submit" loading={isPending}>
@@ -0,0 +1,94 @@
"use client";
import React from "react";
import { Combobox, Group, InputBase, Text, useCombobox } from "@mantine/core";
import { IconCheck, IconDeviceDesktop, IconMoon, IconSun } from "@tabler/icons-react";
import type { ColorScheme } from "@homarr/definitions";
import { colorSchemes } from "@homarr/definitions";
import { useScopedI18n } from "@homarr/translation/client";
const schemeIcons: Record<ColorScheme, React.ElementType> = {
auto: IconDeviceDesktop,
light: IconSun,
dark: IconMoon,
};
interface ColorSchemeComboboxProps {
value: ColorScheme;
onChange: (value: ColorScheme) => void;
width?: string;
}
export const ColorSchemeCombobox = ({ value, onChange, width }: ColorSchemeComboboxProps) => {
const tOptions = useScopedI18n("common.colorScheme.options");
const combobox = useCombobox({
onDropdownClose: () => combobox.resetSelectedOption(),
});
const handleOnOptionSubmit = React.useCallback(
(val: string) => {
if (!val) return;
onChange(val as ColorScheme);
combobox.closeDropdown();
},
[onChange, combobox],
);
const handleOnClick = React.useCallback(() => {
combobox.toggleDropdown();
}, [combobox]);
return (
<Combobox store={combobox} onOptionSubmit={handleOnOptionSubmit}>
<Combobox.Target>
<InputBase
component="button"
type="button"
pointer
rightSection={<Combobox.Chevron />}
rightSectionPointerEvents="none"
onClick={handleOnClick}
variant="filled"
w={width}
>
<OptionItem scheme={value} currentScheme={value} tOptions={tOptions} />
</InputBase>
</Combobox.Target>
<Combobox.Dropdown>
<Combobox.Options>
{colorSchemes.map((scheme) => (
<Combobox.Option value={scheme} key={scheme}>
<OptionItem scheme={scheme} currentScheme={value} tOptions={tOptions} showCheck />
</Combobox.Option>
))}
</Combobox.Options>
</Combobox.Dropdown>
</Combobox>
);
};
const OptionItem = ({
scheme,
currentScheme,
tOptions,
showCheck,
}: {
scheme: ColorScheme;
currentScheme: ColorScheme;
tOptions: (key: ColorScheme) => string;
showCheck?: boolean;
}) => {
const Icon = schemeIcons[scheme];
return (
<Group wrap="nowrap" justify="space-between">
<Group wrap="nowrap">
<Icon size={16} stroke={1.5} />
<Text>{tOptions(scheme)}</Text>
</Group>
{showCheck && scheme === currentScheme && <IconCheck color="currentColor" size={16} />}
</Group>
);
};
@@ -1,49 +1,17 @@
"use client"; "use client";
import { Group, Text, useMantineColorScheme } from "@mantine/core"; import { useMantineColorScheme } from "@mantine/core";
import { IconMoon, IconSun } from "@tabler/icons-react";
import type { ColorScheme } from "@homarr/definitions"; import type { ColorScheme } from "@homarr/definitions";
import { colorSchemes } from "@homarr/definitions";
import { useScopedI18n } from "@homarr/translation/client"; import { ColorSchemeCombobox } from "./color-scheme-combobox";
import { SelectWithCustomItems } from "@homarr/ui";
interface CurrentColorSchemeComboboxProps { interface CurrentColorSchemeComboboxProps {
w?: string; w?: string;
} }
export const CurrentColorSchemeCombobox = ({ w }: CurrentColorSchemeComboboxProps) => { export const CurrentColorSchemeCombobox = ({ w }: CurrentColorSchemeComboboxProps) => {
const tOptions = useScopedI18n("common.colorScheme.options");
const { colorScheme, setColorScheme } = useMantineColorScheme(); const { colorScheme, setColorScheme } = useMantineColorScheme();
return ( return <ColorSchemeCombobox value={colorScheme as ColorScheme} onChange={setColorScheme} width={w} />;
<SelectWithCustomItems
value={colorScheme}
onChange={(value) => setColorScheme((value as ColorScheme | null) ?? "light")}
data={colorSchemes.map((scheme) => ({
value: scheme,
label: tOptions(scheme),
}))}
SelectOption={ColorSchemeCustomOption}
w={w}
/>
);
};
const appearanceIcons = {
light: IconSun,
dark: IconMoon,
};
const ColorSchemeCustomOption = ({ value, label }: { value: ColorScheme; label: string }) => {
const Icon = appearanceIcons[value];
return (
<Group>
<Icon size={16} stroke={1.5} />
<Text fz="sm" fw={500}>
{label}
</Text>
</Group>
);
}; };
@@ -0,0 +1,14 @@
"use client";
import { useEffect } from "react";
export const ServiceWorkerRegistration = () => {
useEffect(() => {
if (!("serviceWorker" in navigator)) return;
navigator.serviceWorker.register("/sw.js", { scope: "/", updateViaCache: "none" }).catch((error) => {
console.error("Service worker registration failed", error);
});
}, []);
return null;
};
@@ -5,16 +5,7 @@ import { useCallback, useEffect } from "react";
import { useRouter } from "next/navigation"; import { useRouter } from "next/navigation";
import { Center, Menu, Stack, Text, useMantineColorScheme } from "@mantine/core"; import { Center, Menu, Stack, Text, useMantineColorScheme } from "@mantine/core";
import { useHotkeys, useTimeout } from "@mantine/hooks"; import { useHotkeys, useTimeout } from "@mantine/hooks";
import { import { IconCheck, IconHome, IconLogin, IconLogout, IconSettings, IconTool } from "@tabler/icons-react";
IconCheck,
IconHome,
IconLogin,
IconLogout,
IconMoon,
IconSettings,
IconSun,
IconTool,
} from "@tabler/icons-react";
import type { RouterOutputs } from "@homarr/api"; import type { RouterOutputs } from "@homarr/api";
import { signOut, useSession } from "@homarr/auth/client"; import { signOut, useSession } from "@homarr/auth/client";
@@ -24,6 +15,7 @@ import { useScopedI18n } from "@homarr/translation/client";
import { Link } from "@homarr/ui"; import { Link } from "@homarr/ui";
import { useAuthContext } from "~/app/[locale]/_client-providers/session"; import { useAuthContext } from "~/app/[locale]/_client-providers/session";
import { CurrentColorSchemeCombobox } from "./color-scheme/current-color-scheme-combobox";
import { CurrentLanguageCombobox } from "./language/current-language-combobox"; import { CurrentLanguageCombobox } from "./language/current-language-combobox";
import { AvailableUpdatesMenuItem } from "./layout/header/update"; import { AvailableUpdatesMenuItem } from "./layout/header/update";
@@ -34,13 +26,9 @@ interface UserAvatarMenuProps {
export const UserAvatarMenu = ({ children, availableUpdatesPromise }: UserAvatarMenuProps) => { export const UserAvatarMenu = ({ children, availableUpdatesPromise }: UserAvatarMenuProps) => {
const t = useScopedI18n("common.userAvatar.menu"); const t = useScopedI18n("common.userAvatar.menu");
const { colorScheme, toggleColorScheme } = useMantineColorScheme(); const { toggleColorScheme } = useMantineColorScheme();
useHotkeys([[hotkeys.toggleColorScheme, toggleColorScheme]]); useHotkeys([[hotkeys.toggleColorScheme, toggleColorScheme]]);
const ColorSchemeIcon = colorScheme === "dark" ? IconSun : IconMoon;
const colorSchemeText = colorScheme === "dark" ? t("switchToLightMode") : t("switchToDarkMode");
const session = useSession(); const session = useSession();
const router = useRouter(); const router = useRouter();
@@ -67,14 +55,14 @@ export const UserAvatarMenu = ({ children, availableUpdatesPromise }: UserAvatar
<Menu width={300} withArrow withinPortal keepMounted> <Menu width={300} withArrow withinPortal keepMounted>
<Menu.Dropdown> <Menu.Dropdown>
<AvailableUpdatesMenuItem availableUpdatesPromise={availableUpdatesPromise} /> <AvailableUpdatesMenuItem availableUpdatesPromise={availableUpdatesPromise} />
<Menu.Item onClick={toggleColorScheme} leftSection={<ColorSchemeIcon size="1rem" />}>
{colorSchemeText}
</Menu.Item>
<Menu.Item component={Link} href="/boards" leftSection={<IconHome size="1rem" />}> <Menu.Item component={Link} href="/boards" leftSection={<IconHome size="1rem" />}>
{t("homeBoard")} {t("homeBoard")}
</Menu.Item> </Menu.Item>
<Menu.Divider /> <Menu.Divider />
<Menu.Item p={0} closeMenuOnClick={false} component="div">
<CurrentColorSchemeCombobox />
</Menu.Item>
<Menu.Item p={0} closeMenuOnClick={false} component="div"> <Menu.Item p={0} closeMenuOnClick={false} component="div">
<CurrentLanguageCombobox /> <CurrentLanguageCombobox />
</Menu.Item> </Menu.Item>
-6
View File
@@ -1,6 +0,0 @@
export async function register() {
if (process.env.NEXT_RUNTIME === "nodejs") {
await import("@homarr/tasks");
await import("@homarr/websocket");
}
}
+12
View File
@@ -0,0 +1,12 @@
// Prevent flash of white background when color scheme is "auto" and OS prefers dark.
// CSS media queries are evaluated synchronously during the browser's initial paint,
// before any JavaScript executes, so this eliminates the white→dark flicker.
html[data-mantine-color-scheme="auto"] {
background-color: #fff;
}
@media (prefers-color-scheme: dark) {
html[data-mantine-color-scheme="auto"] {
background-color: #242424;
}
}
+4 -1
View File
@@ -5,11 +5,12 @@
"license": "Apache-2.0", "license": "Apache-2.0",
"type": "module", "type": "module",
"exports": { "exports": {
".": "./src/main.ts" ".": "./src/index.ts"
}, },
"main": "./src/main.ts", "main": "./src/main.ts",
"types": "./src/main.ts", "types": "./src/main.ts",
"scripts": { "scripts": {
"build": "esbuild src/main.ts --bundle --platform=node --loader:.scss=text --external:*.node --external:@opentelemetry/api --external:deasync --external:bcrypt --outfile=tasks.cjs",
"clean": "rm -rf .turbo node_modules", "clean": "rm -rf .turbo node_modules",
"dev": "pnpm with-env tsx ./src/main.ts", "dev": "pnpm with-env tsx ./src/main.ts",
"format": "prettier --check . --ignore-path ../../.gitignore", "format": "prettier --check . --ignore-path ../../.gitignore",
@@ -23,6 +24,7 @@
"@homarr/auth": "workspace:^0.1.0", "@homarr/auth": "workspace:^0.1.0",
"@homarr/common": "workspace:^0.1.0", "@homarr/common": "workspace:^0.1.0",
"@homarr/core": "workspace:^", "@homarr/core": "workspace:^",
"@homarr/cron-job-api": "workspace:^0.1.0",
"@homarr/cron-jobs": "workspace:^0.1.0", "@homarr/cron-jobs": "workspace:^0.1.0",
"@homarr/cron-jobs-core": "workspace:^0.1.0", "@homarr/cron-jobs-core": "workspace:^0.1.0",
"@homarr/db": "workspace:^0.1.0", "@homarr/db": "workspace:^0.1.0",
@@ -35,6 +37,7 @@
"@homarr/server-settings": "workspace:^0.1.0", "@homarr/server-settings": "workspace:^0.1.0",
"@homarr/validation": "workspace:^0.1.0", "@homarr/validation": "workspace:^0.1.0",
"@homarr/widgets": "workspace:^0.1.0", "@homarr/widgets": "workspace:^0.1.0",
"croner": "catalog:",
"dayjs": "catalog:", "dayjs": "catalog:",
"dotenv": "catalog:", "dotenv": "catalog:",
"fastify": "catalog:", "fastify": "catalog:",
@@ -1,6 +1,7 @@
import { schedule, validate as validateCron } from "node-cron"; import { Cron } from "croner";
import { createLogger } from "@homarr/core/infrastructure/logs"; import { createLogger } from "@homarr/core/infrastructure/logs";
import type { IJobManager } from "@homarr/cron-job-api";
import type { jobGroup as cronJobGroup, JobGroupKeys } from "@homarr/cron-jobs"; import type { jobGroup as cronJobGroup, JobGroupKeys } from "@homarr/cron-jobs";
import type { Database, InferInsertModel } from "@homarr/db"; import type { Database, InferInsertModel } from "@homarr/db";
import { eq } from "@homarr/db"; import { eq } from "@homarr/db";
@@ -8,7 +9,7 @@ import { cronJobConfigurations } from "@homarr/db/schema";
const logger = createLogger({ module: "jobManager" }); const logger = createLogger({ module: "jobManager" });
export class JobManager { export class JobManager implements IJobManager {
constructor( constructor(
private db: Database, private db: Database,
private jobGroup: typeof cronJobGroup, private jobGroup: typeof cronJobGroup,
@@ -20,28 +21,31 @@ export class JobManager {
public async triggerAsync(name: JobGroupKeys): Promise<void> { public async triggerAsync(name: JobGroupKeys): Promise<void> {
await this.jobGroup.runManuallyAsync(name); await this.jobGroup.runManuallyAsync(name);
} }
public async stopAsync(name: JobGroupKeys): Promise<void> { public stop(name: JobGroupKeys): void {
await this.jobGroup.stopAsync(name); this.jobGroup.stop(name);
} }
public async updateIntervalAsync(name: JobGroupKeys, cron: string): Promise<void> { public async updateIntervalAsync(name: JobGroupKeys, cron: string): Promise<void> {
logger.info("Updating cron job interval", { name, expression: cron }); logger.info("Updating cron job interval", { name, expression: cron });
const job = this.jobGroup.getJobRegistry().get(name); const job = this.jobGroup.getJobRegistry().get(name);
if (!job) throw new Error(`Job ${name} not found`); if (!job) throw new Error(`Job ${name} not found`);
if (!validateCron(cron)) {
throw new Error(`Invalid cron expression: ${cron}`);
}
if (job.preventCustomInterval && cron !== job.cronExpression) { if (job.preventCustomInterval && cron !== job.cronExpression) {
throw new Error(`Custom cron expressions are not allowed for job ${name}`); throw new Error(`Custom cron expressions are not allowed for job ${name}`);
} }
await this.updateConfigurationAsync(name, { cronExpression: cron }); const updatedConfig = await this.updateConfigurationAsync(name, { cronExpression: cron });
await this.jobGroup.getTask(name)?.destroy(); this.jobGroup.getTask(name)?.stop();
this.jobGroup.setTask( this.jobGroup.setTask(
name, name,
schedule(cron, () => void job.executeAsync(), { new Cron(
name, cron,
}), {
name,
timezone: job.timezone,
paused: !updatedConfig.isEnabled,
},
() => void job.executeAsync(),
),
); );
logger.info("Cron job interval updated", { name, expression: cron }); logger.info("Cron job interval updated", { name, expression: cron });
} }
@@ -51,7 +55,7 @@ export class JobManager {
if (!job) throw new Error(`Job ${name} not found`); if (!job) throw new Error(`Job ${name} not found`);
await this.updateConfigurationAsync(name, { isEnabled: false }); await this.updateConfigurationAsync(name, { isEnabled: false });
await this.jobGroup.stopAsync(name); this.jobGroup.stop(name);
logger.info("Cron job disabled", { name }); logger.info("Cron job disabled", { name });
} }
public async enableAsync(name: JobGroupKeys): Promise<void> { public async enableAsync(name: JobGroupKeys): Promise<void> {
@@ -85,21 +89,27 @@ export class JobManager {
name, name,
configuration: JSON.stringify(configuration), configuration: JSON.stringify(configuration),
}); });
return; return {
name,
cronExpression: configuration.cronExpression ?? existingConfig.cronExpression,
isEnabled: configuration.isEnabled ?? existingConfig.isEnabled,
};
} }
const job = this.jobGroup.getJobRegistry().get(name); const job = this.jobGroup.getJobRegistry().get(name);
if (!job) throw new Error(`Job ${name} not found`); if (!job) throw new Error(`Job ${name} not found`);
await this.db.insert(cronJobConfigurations).values({ const updatedConfig = {
name, name,
cronExpression: configuration.cronExpression ?? job.cronExpression, cronExpression: configuration.cronExpression ?? job.cronExpression,
isEnabled: configuration.isEnabled ?? true, isEnabled: configuration.isEnabled ?? true,
}); };
await this.db.insert(cronJobConfigurations).values(updatedConfig);
logger.debug("Cron job configuration updated", { logger.debug("Cron job configuration updated", {
name, name,
configuration: JSON.stringify(configuration), configuration: JSON.stringify(configuration),
}); });
return updatedConfig;
} }
public async getAllAsync(): Promise< public async getAllAsync(): Promise<
+41 -1
View File
@@ -1,12 +1,52 @@
// This import has to be the first import in the file so that the agent is overridden before any other modules are imported. // This import has to be the first import in the file so that the agent is overridden before any other modules are imported.
import "./overrides"; import "./overrides";
import { jobGroup } from "@homarr/cron-jobs"; import type { FastifyTRPCPluginOptions } from "@trpc/server/adapters/fastify";
import { fastifyTRPCPlugin } from "@trpc/server/adapters/fastify";
import fastify from "fastify";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
import type { JobRouter } from "@homarr/cron-job-api";
import { jobRouter } from "@homarr/cron-job-api";
import { CRON_JOB_API_KEY_HEADER, CRON_JOB_API_PATH, CRON_JOB_API_PORT } from "@homarr/cron-job-api/constants";
import { jobGroup } from "@homarr/cron-jobs";
import { db } from "@homarr/db";
import { JobManager } from "./job-manager";
import { onStartAsync } from "./on-start"; import { onStartAsync } from "./on-start";
const logger = createLogger({ module: "tasksMain" });
const server = fastify({
maxParamLength: 5000,
});
server.register(fastifyTRPCPlugin, {
prefix: CRON_JOB_API_PATH,
trpcOptions: {
router: jobRouter,
createContext: ({ req }) => ({
manager: new JobManager(db, jobGroup),
apiKey: req.headers[CRON_JOB_API_KEY_HEADER] as string | undefined,
}),
onError({ path, error }) {
logger.error(new ErrorWithMetadata("Error in tasks tRPC handler", { path }, { cause: error }));
},
} satisfies FastifyTRPCPluginOptions<JobRouter>["trpcOptions"],
});
void (async () => { void (async () => {
await onStartAsync(); await onStartAsync();
await jobGroup.initializeAsync(); await jobGroup.initializeAsync();
await jobGroup.startAllAsync(); await jobGroup.startAllAsync();
try {
await server.listen({ port: CRON_JOB_API_PORT });
logger.info("Tasks web server started successfully", { port: CRON_JOB_API_PORT });
} catch (err) {
logger.error(
new ErrorWithMetadata("Failed to start tasks web server", { port: CRON_JOB_API_PORT }, { cause: err }),
);
process.exit(1);
}
})(); })();
+1 -3
View File
@@ -4,12 +4,10 @@
"private": true, "private": true,
"license": "Apache-2.0", "license": "Apache-2.0",
"type": "module", "type": "module",
"exports": {
".": "./src/main.ts"
},
"main": "./src/main.ts", "main": "./src/main.ts",
"types": "./src/main.ts", "types": "./src/main.ts",
"scripts": { "scripts": {
"build": "esbuild src/main.ts --bundle --platform=node --outfile=wssServer.cjs --external:bcrypt --external:@opentelemetry/api --external:deasync --external:cpu-features --loader:.html=text --loader:.scss=text --loader:.node=text",
"clean": "rm -rf .turbo node_modules", "clean": "rm -rf .turbo node_modules",
"dev": "pnpm with-env tsx ./src/main.ts", "dev": "pnpm with-env tsx ./src/main.ts",
"format": "prettier --check . --ignore-path ../../.gitignore", "format": "prettier --check . --ignore-path ../../.gitignore",
+7
View File
@@ -372,6 +372,13 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="https://homarr.dev/docs/integrations/umami" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/umami.svg" alt="Umami" width="90" height="90" />
<br/>
<p align="center">Umami</p>
</a>
</td>
<td align="center">
<a href="https://homarr.dev/docs/integrations/unifi-controller" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/unifi-controller" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/unifi.png" alt="Unifi Controller" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/unifi.png" alt="Unifi Controller" width="90" height="90" />
<br/> <br/>
+5 -5
View File
@@ -1,6 +1,6 @@
{ {
"name": "homarr", "name": "homarr",
"version": "1.59.3", "version": "1.61.1",
"private": true, "private": true,
"scripts": { "scripts": {
"build": "cross-env CI=true turbo build", "build": "cross-env CI=true turbo build",
@@ -15,7 +15,7 @@
"db:migration:sqlite:run": "pnpm -F db migration:sqlite:run", "db:migration:sqlite:run": "pnpm -F db migration:sqlite:run",
"db:push": "pnpm -F db push:sqlite", "db:push": "pnpm -F db push:sqlite",
"db:studio": "pnpm -F db studio", "db:studio": "pnpm -F db studio",
"dev": "pnpm -F nextjs dev", "dev": "turbo dev --parallel",
"docker:dev": "docker compose -f ./development/development.docker-compose.yml up", "docker:dev": "docker compose -f ./development/development.docker-compose.yml up",
"format": "turbo format --continue -- --cache --cache-location node_modules/.cache/.prettiercache", "format": "turbo format --continue -- --cache --cache-location node_modules/.cache/.prettiercache",
"format:fix": "turbo format --continue -- --write --cache --cache-location node_modules/.cache/.prettiercache", "format:fix": "turbo format --continue -- --write --cache --cache-location node_modules/.cache/.prettiercache",
@@ -79,14 +79,14 @@
"overrides": { "overrides": {
"@babel/helpers@<7.26.10": ">=7.29.2", "@babel/helpers@<7.26.10": ">=7.29.2",
"@babel/runtime@<7.26.10": ">=7.29.2", "@babel/runtime@<7.26.10": ">=7.29.2",
"axios@>=1.0.0 <1.8.2": ">=1.15.2", "axios@>=1.0.0 <1.8.2": ">=1.16.0",
"brace-expansion@>=2.0.0 <=2.0.1": ">=5.0.5", "brace-expansion@>=2.0.0 <=2.0.1": ">=5.0.5",
"brace-expansion@>=1.0.0 <=1.1.11": ">=5.0.5", "brace-expansion@>=1.0.0 <=1.1.11": ">=5.0.5",
"esbuild@<=0.24.2": ">=0.28.0", "esbuild@<=0.24.2": ">=0.28.0",
"form-data@>=4.0.0 <4.0.4": ">=4.0.5", "form-data@>=4.0.0 <4.0.4": ">=4.0.5",
"hono@<4.6.5": ">=4.12.15", "hono@<4.6.5": ">=4.12.16",
"linkifyjs@<4.3.2": ">=4.3.2", "linkifyjs@<4.3.2": ">=4.3.2",
"nanoid@>=4.0.0 <5.0.9": ">=5.1.9", "nanoid@>=4.0.0 <5.0.9": ">=5.1.11",
"prismjs@<1.30.0": ">=1.30.0", "prismjs@<1.30.0": ">=1.30.0",
"proxmox-api>undici": "7.24.6", "proxmox-api>undici": "7.24.6",
"react-is": "^19.2.5", "react-is": "^19.2.5",
+1
View File
@@ -25,6 +25,7 @@
"@homarr/auth": "workspace:^0.1.0", "@homarr/auth": "workspace:^0.1.0",
"@homarr/common": "workspace:^0.1.0", "@homarr/common": "workspace:^0.1.0",
"@homarr/core": "workspace:^0.1.0", "@homarr/core": "workspace:^0.1.0",
"@homarr/cron-job-api": "workspace:^0.1.0",
"@homarr/cron-job-status": "workspace:^0.1.0", "@homarr/cron-job-status": "workspace:^0.1.0",
"@homarr/cron-jobs": "workspace:^0.1.0", "@homarr/cron-jobs": "workspace:^0.1.0",
"@homarr/db": "workspace:^0.1.0", "@homarr/db": "workspace:^0.1.0",
+1
View File
@@ -26,6 +26,7 @@ export const appRouter = createTRPCRouter({
media: lazy(() => import("./router/medias/media-router").then((mod) => mod.mediaRouter)), media: lazy(() => import("./router/medias/media-router").then((mod) => mod.mediaRouter)),
updateChecker: lazy(() => import("./router/update-checker").then((mod) => mod.updateCheckerRouter)), updateChecker: lazy(() => import("./router/update-checker").then((mod) => mod.updateCheckerRouter)),
certificates: lazy(() => import("./router/certificates/certificate-router").then((mod) => mod.certificateRouter)), certificates: lazy(() => import("./router/certificates/certificate-router").then((mod) => mod.certificateRouter)),
bangs: lazy(() => import("./router/bangs/bangs-router").then((mod) => mod.bangsRouter)),
info: lazy(() => import("./router/info").then((mod) => mod.infoRouter)), info: lazy(() => import("./router/info").then((mod) => mod.infoRouter)),
}); });
@@ -0,0 +1,17 @@
import { z } from "zod/v4";
import { searchDuckDuckGoBangsAsync } from "../../services/duckduckgo-bangs";
import { createTRPCRouter, publicProcedure } from "../../trpc";
export const bangsRouter = createTRPCRouter({
search: publicProcedure
.input(
z.object({
query: z.string(),
limit: z.number().int().min(1).max(50).default(20),
}),
)
.query(async ({ input }) => {
return await searchDuckDuckGoBangsAsync({ query: input.query, limit: input.limit });
}),
});
+17 -20
View File
@@ -2,62 +2,59 @@ import { observable } from "@trpc/server/observable";
import z from "zod/v4"; import z from "zod/v4";
import { createLogger } from "@homarr/core/infrastructure/logs"; import { createLogger } from "@homarr/core/infrastructure/logs";
import { jobGroupKeys, jobNameSchema } from "@homarr/cron-job-api";
import { cronJobApi } from "@homarr/cron-job-api/client";
import type { TaskStatus } from "@homarr/cron-job-status"; import type { TaskStatus } from "@homarr/cron-job-status";
import { createCronJobStatusChannel } from "@homarr/cron-job-status"; import { createCronJobStatusChannel } from "@homarr/cron-job-status";
import { cronExpressionSchema, jobGroup } from "@homarr/cron-jobs";
import { JobManager } from "@homarr/cron-jobs/job-manager";
import { createTRPCRouter, permissionRequiredProcedure } from "../trpc"; import { createTRPCRouter, permissionRequiredProcedure } from "../trpc";
const jobGroupKeys = jobGroup.getKeys();
const jobNameSchema = z.enum(jobGroup.getKeys());
const logger = createLogger({ module: "cronJobsRouter" }); const logger = createLogger({ module: "cronJobsRouter" });
export const cronJobsRouter = createTRPCRouter({ export const cronJobsRouter = createTRPCRouter({
triggerJob: permissionRequiredProcedure triggerJob: permissionRequiredProcedure
.requiresPermission("admin") .requiresPermission("admin")
.input(jobNameSchema) .input(jobNameSchema)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input }) => {
await new JobManager(ctx.db, jobGroup).triggerAsync(input); await cronJobApi.trigger.mutate(input);
}), }),
startJob: permissionRequiredProcedure startJob: permissionRequiredProcedure
.requiresPermission("admin") .requiresPermission("admin")
.input(jobNameSchema) .input(jobNameSchema)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input }) => {
await new JobManager(ctx.db, jobGroup).startAsync(input); await cronJobApi.start.mutate(input);
}), }),
stopJob: permissionRequiredProcedure stopJob: permissionRequiredProcedure
.requiresPermission("admin") .requiresPermission("admin")
.input(jobNameSchema) .input(jobNameSchema)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input }) => {
await new JobManager(ctx.db, jobGroup).stopAsync(input); await cronJobApi.stop.mutate(input);
}), }),
updateJobInterval: permissionRequiredProcedure updateJobInterval: permissionRequiredProcedure
.requiresPermission("admin") .requiresPermission("admin")
.input( .input(
z.object({ z.object({
name: jobNameSchema, name: jobNameSchema,
cron: cronExpressionSchema, cron: z.string(),
}), }),
) )
.mutation(async ({ input, ctx }) => { .mutation(async ({ input }) => {
await new JobManager(ctx.db, jobGroup).updateIntervalAsync(input.name, input.cron); await cronJobApi.updateInterval.mutate(input);
}), }),
disableJob: permissionRequiredProcedure disableJob: permissionRequiredProcedure
.requiresPermission("admin") .requiresPermission("admin")
.input(jobNameSchema) .input(jobNameSchema)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input }) => {
await new JobManager(ctx.db, jobGroup).disableAsync(input); await cronJobApi.disable.mutate(input);
}), }),
enableJob: permissionRequiredProcedure enableJob: permissionRequiredProcedure
.requiresPermission("admin") .requiresPermission("admin")
.input(jobNameSchema) .input(jobNameSchema)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input }) => {
await new JobManager(ctx.db, jobGroup).enableAsync(input); await cronJobApi.enable.mutate(input);
}), }),
getJobs: permissionRequiredProcedure.requiresPermission("admin").query(async ({ ctx }) => { getJobs: permissionRequiredProcedure.requiresPermission("admin").query(async () => {
return await new JobManager(ctx.db, jobGroup).getAllAsync(); return await cronJobApi.getAll.query();
}), }),
subscribeToStatusUpdates: permissionRequiredProcedure.requiresPermission("admin").subscription(() => { subscribeToStatusUpdates: permissionRequiredProcedure.requiresPermission("admin").subscription(() => {
return observable<TaskStatus>((emit) => { return observable<TaskStatus>((emit) => {
@@ -138,6 +138,7 @@ const getContainerOrThrowAsync = async (id: string) => {
interface DockerContainer { interface DockerContainer {
name: string; name: string;
id: string; id: string;
host: string;
state: ContainerState; state: ContainerState;
image: string; image: string;
ports: Port[] | undefined; ports: Port[] | undefined;
+31 -1
View File
@@ -21,6 +21,7 @@ import {
userChangePasswordApiSchema, userChangePasswordApiSchema,
userChangeSearchPreferencesSchema, userChangeSearchPreferencesSchema,
userCreateSchema, userCreateSchema,
userDdgBangsSchema,
userEditProfileSchema, userEditProfileSchema,
userFirstDayOfWeekSchema, userFirstDayOfWeekSchema,
userInitSchema, userInitSchema,
@@ -110,7 +111,7 @@ export const userRouter = createTRPCRouter({
const queryResult = (await trx.delete(schema.invites).where(inviteWhere)) as const queryResult = (await trx.delete(schema.invites).where(inviteWhere)) as
| QueryResult | QueryResult
| MySqlRawQueryResult; | MySqlRawQueryResult;
let count = 0; let count: number;
if (Array.isArray(queryResult)) { if (Array.isArray(queryResult)) {
count = queryResult[0].affectedRows; count = queryResult[0].affectedRows;
} else { } else {
@@ -276,6 +277,7 @@ export const userRouter = createTRPCRouter({
pingIconsEnabled: true, pingIconsEnabled: true,
defaultSearchEngineId: true, defaultSearchEngineId: true,
openSearchInNewTab: true, openSearchInNewTab: true,
ddgBangs: true,
}), }),
) )
.meta({ openapi: { method: "GET", path: "/api/users/{userId}", tags: ["users"], protect: true } }) .meta({ openapi: { method: "GET", path: "/api/users/{userId}", tags: ["users"], protect: true } })
@@ -301,6 +303,7 @@ export const userRouter = createTRPCRouter({
pingIconsEnabled: true, pingIconsEnabled: true,
defaultSearchEngineId: true, defaultSearchEngineId: true,
openSearchInNewTab: true, openSearchInNewTab: true,
ddgBangs: true,
}, },
where: eq(users.id, input.userId), where: eq(users.id, input.userId),
}); });
@@ -541,6 +544,33 @@ export const userRouter = createTRPCRouter({
}) })
.where(eq(users.id, ctx.session.user.id)); .where(eq(users.id, ctx.session.user.id));
}), }),
changeDdgBangs: protectedProcedure
.input(convertIntersectionToZodObject(userDdgBangsSchema.and(byIdSchema)))
.output(z.void())
.meta({
openapi: {
method: "PATCH",
path: "/api/users/ddg-bangs",
tags: ["users"],
protect: true,
deprecated: true,
},
})
.mutation(async ({ input, ctx }) => {
if (!ctx.session.user.permissions.includes("admin") && ctx.session.user.id !== input.id) {
throw new TRPCError({
code: "NOT_FOUND",
message: "User not found",
});
}
await ctx.db
.update(users)
.set({
ddgBangs: input.ddgBangs,
})
.where(eq(users.id, input.id));
}),
changeFirstDayOfWeek: protectedProcedure changeFirstDayOfWeek: protectedProcedure
.input(convertIntersectionToZodObject(userFirstDayOfWeekSchema.and(byIdSchema))) .input(convertIntersectionToZodObject(userFirstDayOfWeekSchema.and(byIdSchema)))
.output(z.void()) .output(z.void())
@@ -15,10 +15,13 @@ export const changeSearchPreferencesInputSchema = userChangeSearchPreferencesSch
export const changeSearchPreferencesAsync = async ( export const changeSearchPreferencesAsync = async (
db: Database, db: Database,
session: Session, session: Session,
input: Modify<z.infer<typeof changeSearchPreferencesInputSchema>, { openInNewTab: boolean | undefined }>, input: Modify<
z.infer<typeof changeSearchPreferencesInputSchema>,
{ openInNewTab: boolean | undefined; ddgBangsEnabled: boolean | undefined }
>,
) => { ) => {
const user = session.user; const user = session.user;
// Only admins can change other users passwords // Only admins can change other users search preferences
if (!user.permissions.includes("admin") && user.id !== input.userId) { if (!user.permissions.includes("admin") && user.id !== input.userId) {
throw new TRPCError({ throw new TRPCError({
code: "NOT_FOUND", code: "NOT_FOUND",
@@ -45,6 +48,7 @@ export const changeSearchPreferencesAsync = async (
.set({ .set({
defaultSearchEngineId: input.defaultSearchEngineId, defaultSearchEngineId: input.defaultSearchEngineId,
openSearchInNewTab: input.openInNewTab, openSearchInNewTab: input.openInNewTab,
ddgBangs: input.ddgBangsEnabled,
}) })
.where(eq(users.id, input.userId)); .where(eq(users.id, input.userId));
}; };
+23 -1
View File
@@ -2,6 +2,8 @@ import { observable } from "@trpc/server/observable";
import { z } from "zod/v4"; import { z } from "zod/v4";
import type { Modify } from "@homarr/common/types"; import type { Modify } from "@homarr/common/types";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
import type { Integration } from "@homarr/db/schema"; import type { Integration } from "@homarr/db/schema";
import type { IntegrationKindByCategory } from "@homarr/definitions"; import type { IntegrationKindByCategory } from "@homarr/definitions";
import { getIntegrationKindsByCategory } from "@homarr/definitions"; import { getIntegrationKindsByCategory } from "@homarr/definitions";
@@ -12,6 +14,8 @@ import { calendarMonthRequestHandler } from "@homarr/request-handler/calendar";
import { createManyIntegrationMiddleware } from "../../middlewares/integration"; import { createManyIntegrationMiddleware } from "../../middlewares/integration";
import { createTRPCRouter, publicProcedure } from "../../trpc"; import { createTRPCRouter, publicProcedure } from "../../trpc";
const logger = createLogger({ module: "calendarRouter" });
export const calendarRouter = createTRPCRouter({ export const calendarRouter = createTRPCRouter({
findAllEvents: publicProcedure findAllEvents: publicProcedure
.input( .input(
@@ -24,7 +28,7 @@ export const calendarRouter = createTRPCRouter({
) )
.concat(createManyIntegrationMiddleware("query", ...getIntegrationKindsByCategory("calendar"))) .concat(createManyIntegrationMiddleware("query", ...getIntegrationKindsByCategory("calendar")))
.query(async ({ ctx, input }) => { .query(async ({ ctx, input }) => {
return await Promise.all( const settled = await Promise.allSettled(
ctx.integrations.map(async (integration) => { ctx.integrations.map(async (integration) => {
const { integrationIds: _integrationIds, ...handlerInput } = input; const { integrationIds: _integrationIds, ...handlerInput } = input;
const innerHandler = calendarMonthRequestHandler.handler(integration, handlerInput); const innerHandler = calendarMonthRequestHandler.handler(integration, handlerInput);
@@ -40,6 +44,24 @@ export const calendarRouter = createTRPCRouter({
}; };
}), }),
); );
return settled.flatMap((result, index) => {
if (result.status === "fulfilled") {
return [result.value];
}
const integration = ctx.integrations[index];
logger.warn(
new ErrorWithMetadata(
"Calendar integration request failed; skipping events for this integration",
{
integrationId: integration?.id,
integrationKind: integration?.kind,
},
{ cause: result.reason },
),
);
return [];
});
}), }),
subscribeToEvents: publicProcedure subscribeToEvents: publicProcedure
.input( .input(
+1
View File
@@ -30,4 +30,5 @@ export const widgetRouter = createTRPCRouter({
timetable: lazy(() => import("./timetable").then((mod) => mod.timetableRouter)), timetable: lazy(() => import("./timetable").then((mod) => mod.timetableRouter)),
tracearr: lazy(() => import("./tracearr").then((mod) => mod.tracearrRouter)), tracearr: lazy(() => import("./tracearr").then((mod) => mod.tracearrRouter)),
speedtestTracker: lazy(() => import("./speedtest-tracker").then((mod) => mod.speedtestTrackerRouter)), speedtestTracker: lazy(() => import("./speedtest-tracker").then((mod) => mod.speedtestTrackerRouter)),
umami: lazy(() => import("./umami").then((mod) => mod.umamiRouter)),
}); });
+205
View File
@@ -0,0 +1,205 @@
import { observable } from "@trpc/server/observable";
import { z } from "zod/v4";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
import { createIntegrationAsync } from "@homarr/integrations";
import {
umamiActiveVisitorsRequestHandler,
umamiEventNamesRequestHandler,
umamiMultiEventRequestHandler,
umamiRequestHandler,
umamiTopPagesRequestHandler,
umamiTopReferrersRequestHandler,
} from "@homarr/request-handler/umami";
import { createManyIntegrationMiddleware, createOneIntegrationMiddleware } from "../../middlewares/integration";
import { createTRPCRouter, publicProcedure } from "../../trpc";
const logger = createLogger({ module: "umami-router" });
export const umamiRouter = createTRPCRouter({
getWebsites: publicProcedure.concat(createOneIntegrationMiddleware("query", "umami")).query(async ({ ctx }) => {
try {
const instance = await createIntegrationAsync(ctx.integration);
return await instance.getWebsitesAsync();
} catch (error) {
logger.warn(new Error("Failed to load websites", { cause: error }));
return [];
}
}),
getVisitorStats: publicProcedure
.input(
z.object({
websiteId: z.string(),
timeFrame: z.string(),
eventName: z.string().optional(),
}),
)
.concat(createManyIntegrationMiddleware("query", "umami"))
.query(async ({ ctx, input }) => {
const results = await Promise.all(
ctx.integrations.map(async (integration) => {
const innerHandler = umamiRequestHandler.handler(integration, {
websiteId: input.websiteId,
timeFrame: input.timeFrame,
eventName: input.eventName,
});
const { data, timestamp } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
return {
integrationId: integration.id,
integrationName: integration.name,
integrationUrl: integration.url,
visitorStats: data,
updatedAt: timestamp,
};
}),
);
return results;
}),
getEventNames: publicProcedure
.input(z.object({ websiteId: z.string() }))
.concat(createOneIntegrationMiddleware("query", "umami"))
.query(async ({ ctx, input }) => {
try {
const innerHandler = umamiEventNamesRequestHandler.handler(ctx.integration, { websiteId: input.websiteId });
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
return data;
} catch (error) {
logger.warn(
new ErrorWithMetadata("Failed to load event names", { websiteId: input.websiteId }, { cause: error }),
);
return [];
}
}),
getTopPages: publicProcedure
.input(
z.object({
websiteId: z.string(),
timeFrame: z.string(),
limit: z.number().int().min(1).max(500),
}),
)
.concat(createOneIntegrationMiddleware("query", "umami"))
.query(async ({ ctx, input }) => {
try {
const innerHandler = umamiTopPagesRequestHandler.handler(ctx.integration, {
websiteId: input.websiteId,
timeFrame: input.timeFrame,
limit: input.limit,
});
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
return data;
} catch (error) {
logger.warn(
new ErrorWithMetadata(
"Failed to load top pages",
{ websiteId: input.websiteId, timeFrame: input.timeFrame, limit: input.limit },
{ cause: error },
),
);
return [];
}
}),
getTopReferrers: publicProcedure
.input(
z.object({
websiteId: z.string(),
timeFrame: z.string(),
limit: z.number().int().min(1).max(500),
}),
)
.concat(createOneIntegrationMiddleware("query", "umami"))
.query(async ({ ctx, input }) => {
try {
const innerHandler = umamiTopReferrersRequestHandler.handler(ctx.integration, {
websiteId: input.websiteId,
timeFrame: input.timeFrame,
limit: input.limit,
});
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
return data;
} catch (error) {
logger.warn(
new ErrorWithMetadata(
"Failed to load top referrers",
{ websiteId: input.websiteId, timeFrame: input.timeFrame, limit: input.limit },
{ cause: error },
),
);
return [];
}
}),
getMultiEventTimeSeries: publicProcedure
.input(
z.object({
websiteId: z.string(),
timeFrame: z.string(),
eventNames: z.array(z.string()),
}),
)
.concat(createOneIntegrationMiddleware("query", "umami"))
.query(async ({ ctx, input }) => {
try {
const sortedNames = [...input.eventNames].sort();
const innerHandler = umamiMultiEventRequestHandler.handler(ctx.integration, {
websiteId: input.websiteId,
timeFrame: input.timeFrame,
eventNames: sortedNames,
});
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
return data;
} catch (error) {
logger.warn(
new ErrorWithMetadata(
"Failed to load multi-event time series",
{ websiteId: input.websiteId, timeFrame: input.timeFrame, eventNames: JSON.stringify(input.eventNames) },
{ cause: error },
),
);
return [];
}
}),
getActiveVisitors: publicProcedure
.input(z.object({ websiteId: z.string() }))
.concat(createOneIntegrationMiddleware("query", "umami"))
.query(async ({ ctx, input }) => {
try {
const innerHandler = umamiActiveVisitorsRequestHandler.handler(ctx.integration, {
websiteId: input.websiteId,
});
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
return data;
} catch (error) {
logger.warn(
new ErrorWithMetadata("Failed to load active visitors", { websiteId: input.websiteId }, { cause: error }),
);
return 0;
}
}),
subscribeActiveVisitors: publicProcedure
.input(z.object({ websiteId: z.string() }))
.concat(createOneIntegrationMiddleware("query", "umami"))
.subscription(({ ctx, input }) => {
return observable<number>((emit) => {
const innerHandler = umamiActiveVisitorsRequestHandler.handler(ctx.integration, {
websiteId: input.websiteId,
});
const unsubscribe = innerHandler.subscribe((count) => {
emit.next(count);
});
return () => {
unsubscribe();
};
});
}),
});
@@ -0,0 +1,55 @@
import { duckDuckGoBangsRequestHandler } from "@homarr/request-handler/duckduckgo-bangs";
import type { DuckDuckGoBang } from "@homarr/request-handler/duckduckgo-bangs";
// DuckDuckGo bang keys are intentionally short:
// - `t`: token (e.g. "yt"), `s`: display name, `u`: URL template (contains `{{{s}}}`)
// - `d`: domain, `c`: category, `sc`: subcategory, `r`: rank (optional)
const normalizeBangToken = (token: string) => token.toLowerCase().trim();
/**
* Binary search to find the first index where bang.t >= tokenPrefix.
* This is O(log n) vs O(n) for findIndex, which matters because DuckDuckGo
* has ~13,000+ bangs. Combined with the pre-sorted data, this allows
* efficient prefix matching by finding the start position and iterating
* only through consecutive matches.
*/
const lowerBound = (arr: DuckDuckGoBang[], tokenPrefix: string) => {
let low = 0;
let high = arr.length;
while (low < high) {
const mid = (low + high) >> 1;
const midBang = arr[mid];
// Must use the same ordering as the source list sort (localeCompare),
// otherwise binary search can miss tokens with symbols like "&" or "_".
if (!midBang || midBang.t.localeCompare(tokenPrefix) >= 0) {
high = mid;
continue;
}
low = mid + 1;
}
return low;
};
export const searchDuckDuckGoBangsAsync = async (input: {
query: string;
limit: number;
}): Promise<DuckDuckGoBang[]> => {
const queryTokenPrefix = normalizeBangToken(input.query);
if (!queryTokenPrefix) return [];
const { data: allBangs } = await duckDuckGoBangsRequestHandler.handler({}).getCachedOrUpdatedDataAsync({});
const startIndex = lowerBound(allBangs, queryTokenPrefix);
const matches: DuckDuckGoBang[] = [];
for (let index = startIndex; index < allBangs.length; index++) {
const bang = allBangs[index];
if (!bang) break;
if (!bang.t.startsWith(queryTokenPrefix)) break;
matches.push(bang);
if (matches.length >= input.limit) break;
}
return matches;
};
+1 -1
View File
@@ -36,7 +36,7 @@ export const createSessionAsync = async (
...user, ...user,
email: user.email ?? "", email: user.email ?? "",
permissions: await getCurrentUserPermissionsAsync(db, user.id), permissions: await getCurrentUserPermissionsAsync(db, user.id),
colorScheme: "dark", colorScheme: "auto",
}, },
} as Session; } as Session;
}; };
+7 -3
View File
@@ -15,7 +15,7 @@
} }
}, },
"scripts": { "scripts": {
"build": "esbuild src/index.ts --bundle --platform=node --outfile=cli.cjs --external:bcrypt --external:cpu-features --loader:.html=text --loader:.node=text", "build": "esbuild src/index.ts --bundle --platform=node --outfile=cli.cjs --external:bcrypt --external:cpu-features --external:better-sqlite3 --external:mysql2 --external:pg --loader:.html=text --loader:.node=text",
"clean": "rm -rf .turbo node_modules", "clean": "rm -rf .turbo node_modules",
"format": "prettier --check . --ignore-path ../../.gitignore", "format": "prettier --check . --ignore-path ../../.gitignore",
"lint": "eslint", "lint": "eslint",
@@ -25,12 +25,16 @@
}, },
"prettier": "@homarr/prettier-config", "prettier": "@homarr/prettier-config",
"dependencies": { "dependencies": {
"@drizzle-team/brocli": "catalog:",
"@homarr/auth": "workspace:^0.1.0", "@homarr/auth": "workspace:^0.1.0",
"@homarr/common": "workspace:^0.1.0", "@homarr/common": "workspace:^0.1.0",
"@homarr/core": "workspace:^0.1.0",
"@homarr/db": "workspace:^0.1.0", "@homarr/db": "workspace:^0.1.0",
"@homarr/validation": "workspace:^0.1.0", "@homarr/validation": "workspace:^0.1.0",
"dotenv": "catalog:" "better-sqlite3": "catalog:",
"dotenv": "catalog:",
"drizzle-orm": "catalog:",
"mysql2": "catalog:",
"pg": "catalog:"
}, },
"devDependencies": { "devDependencies": {
"@homarr/eslint-config": "workspace:^0.2.0", "@homarr/eslint-config": "workspace:^0.2.0",
+127
View File
@@ -0,0 +1,127 @@
import Database from "better-sqlite3";
import { drizzle as drizzleSqlite } from "drizzle-orm/better-sqlite3";
import { drizzle as drizzleMysql } from "drizzle-orm/mysql2";
import { drizzle as drizzlePostgres } from "drizzle-orm/node-postgres";
import mysql from "mysql2";
import type { Pool as MysqlPool } from "mysql2";
import { Pool as PostgresPool } from "pg";
import { DB_CASING } from "@homarr/core/infrastructure/db/constants";
import { dbEnv } from "@homarr/core/infrastructure/db/env";
import { schema } from "@homarr/db/schema";
const CONNECT_TIMEOUT_MS = 10_000;
const dbConfig = {
schema,
casing: DB_CASING,
};
export type CliDatabase = ReturnType<typeof drizzleSqlite<typeof schema>>;
type CliConnection =
| { driver: "better-sqlite3"; raw: Database.Database; db: CliDatabase }
| { driver: "mysql2"; raw: MysqlPool; db: CliDatabase }
| { driver: "node-postgres"; raw: PostgresPool; db: CliDatabase };
let connection: CliConnection | null = null;
const createMysqlPool = () => {
const poolOptions = {
maxIdle: 0,
idleTimeout: 60000,
enableKeepAlive: true,
connectTimeout: CONNECT_TIMEOUT_MS,
};
if (!dbEnv.HOST) {
return mysql.createPool({ ...poolOptions, uri: dbEnv.URL });
}
return mysql.createPool({
...poolOptions,
host: dbEnv.HOST,
port: dbEnv.PORT,
database: dbEnv.NAME,
user: dbEnv.USER,
password: dbEnv.PASSWORD,
});
};
const createPostgresPool = () => {
const poolOptions = {
max: 1,
idleTimeoutMillis: 60000,
connectionTimeoutMillis: CONNECT_TIMEOUT_MS,
allowExitOnIdle: true,
};
if (!dbEnv.HOST) {
return new PostgresPool({
...poolOptions,
connectionString: dbEnv.URL,
});
}
return new PostgresPool({
...poolOptions,
host: dbEnv.HOST,
port: dbEnv.PORT,
database: dbEnv.NAME,
user: dbEnv.USER,
password: dbEnv.PASSWORD,
});
};
const connectionFactories = {
"better-sqlite3": (): CliConnection => {
const raw = new Database(dbEnv.URL);
const db = drizzleSqlite(raw, dbConfig);
return { driver: "better-sqlite3", raw, db };
},
mysql2: (): CliConnection => {
const raw = createMysqlPool();
const db = drizzleMysql(raw, { ...dbConfig, mode: "default" }) as unknown as CliDatabase;
return { driver: "mysql2", raw, db };
},
"node-postgres": (): CliConnection => {
const raw = createPostgresPool();
const db = drizzlePostgres({ ...dbConfig, client: raw }) as unknown as CliDatabase;
return { driver: "node-postgres", raw, db };
},
};
const closeHandlers: Record<CliConnection["driver"], (entry: CliConnection) => Promise<void>> = {
"better-sqlite3": async (entry) => {
(entry as Extract<CliConnection, { driver: "better-sqlite3" }>).raw.close();
},
mysql2: (entry) => {
const pool = (entry as Extract<CliConnection, { driver: "mysql2" }>).raw;
return new Promise<void>((resolve, reject) => {
pool.end((err) => (err ? reject(err) : resolve()));
});
},
"node-postgres": async (entry) => {
await (entry as Extract<CliConnection, { driver: "node-postgres" }>).raw.end();
},
};
export const getCliDb = (): CliDatabase => {
if (connection) {
return connection.db;
}
const driver = dbEnv.DRIVER ?? "better-sqlite3";
connection = connectionFactories[driver]();
return connection.db;
};
export const closeCliDbAsync = async (): Promise<void> => {
if (!connection) {
return;
}
const current = connection;
connection = null;
await closeHandlers[current.driver](current);
};
+28 -29
View File
@@ -1,36 +1,35 @@
import { command } from "@drizzle-team/brocli"; import { eq } from "drizzle-orm";
import { db, eq } from "@homarr/db"; import { getCliDb } from "../cli-db";
import { requireCredentialsProvider } from "../errors";
import { users } from "@homarr/db/schema"; import { users } from "@homarr/db/schema";
export const fixUsernames = command({ export async function fixUsernamesHandler(): Promise<number> {
name: "fix-usernames", requireCredentialsProvider();
desc: "Changes all credentials usernames to lowercase",
// eslint-disable-next-line no-restricted-syntax const db = getCliDb();
handler: async () => { const credentialUsers = await db.query.users.findMany({
if (!process.env.AUTH_PROVIDERS?.toLowerCase().includes("credentials")) { where: eq(users.provider, "credentials"),
console.error("Credentials provider is not enabled"); });
return;
for (const user of credentialUsers) {
if (!user.name) {
continue;
}
if (user.name === user.name.toLowerCase()) {
continue;
} }
const credentialUsers = await db.query.users.findMany({ await db
where: eq(users.provider, "credentials"), .update(users)
}); .set({
name: user.name.toLowerCase(),
})
.where(eq(users.id, user.id));
for (const user of credentialUsers) { console.log(`Changed username from ${user.name} to ${user.name.toLowerCase()}`);
if (!user.name) continue; }
if (user.name === user.name.toLowerCase()) continue;
await db console.log("All usernames have been fixed");
.update(users) return 0;
.set({ }
name: user.name.toLowerCase(),
})
.where(eq(users.id, user.id));
console.log(`Changed username from ${user.name} to ${user.name.toLowerCase()}`);
}
console.log("All usernames have been fixed");
},
});
@@ -1,39 +1,50 @@
import { command, string } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { db, eq } from "@homarr/db"; import { eq } from "drizzle-orm";
import type { CliDatabase } from "../cli-db";
import { getCliDb } from "../cli-db";
import { CliError } from "../errors";
import { integrations } from "@homarr/db/schema"; import { integrations } from "@homarr/db/schema";
export const integrationsDelete = command({ const integrationLookup: Record<
name: "delete", "id" | "name",
desc: "Delete an integration by id or name", (db: CliDatabase, value: string) => Promise<{ id: string; name: string } | undefined>
options: { > = {
id: string("id").alias("i").desc("ID of the integration"), id: (db, value) =>
name: string("name").alias("n").desc("Name of the integration"), db.query.integrations.findFirst({
}, where: eq(integrations.id, value),
// eslint-disable-next-line no-restricted-syntax }),
handler: async (options) => { name: (db, value) =>
if (!options.id && !options.name) { db.query.integrations.findFirst({
console.error("Either --id or --name must be provided"); where: eq(integrations.name, value),
return; }),
} };
let entry; export async function integrationsDeleteHandler(args: string[]): Promise<number> {
if (options.id) { const { values } = parseArgs({
entry = await db.query.integrations.findFirst({ args,
where: eq(integrations.id, options.id), options: {
}); id: { type: "string", short: "i" },
} else if (options.name) { name: { type: "string", short: "n" },
entry = await db.query.integrations.findFirst({ },
where: eq(integrations.name, options.name), });
});
}
if (!entry) { const lookupKey = values.id ? "id" : values.name ? "name" : null;
console.error("Integration not found"); const lookupValue = values.id ?? values.name;
return;
}
await db.delete(integrations).where(eq(integrations.id, entry.id)); if (!lookupKey || !lookupValue) {
console.log(`Integration ${entry.name} (${entry.id}) deleted`); throw new CliError("Either --id or --name must be provided", 2);
}, }
});
const db = getCliDb();
const entry = await integrationLookup[lookupKey](db, lookupValue);
if (!entry) {
throw new CliError("Integration not found");
}
await db.delete(integrations).where(eq(integrations.id, entry.id));
console.log(`Integration ${entry.name} (${entry.id}) deleted`);
return 0;
}
+32 -18
View File
@@ -1,21 +1,35 @@
import { command } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { db } from "@homarr/db"; import { getCliDb } from "../cli-db";
import { printTable } from "../utils";
export const integrationsList = command({ export async function integrationsListHandler(args: string[] = []): Promise<number> {
name: "list", const { values } = parseArgs({
desc: "List all integrations (id and name)", args,
// eslint-disable-next-line no-restricted-syntax options: {
handler: async () => { json: { type: "boolean", default: false },
const all = await db.query.integrations.findMany(); },
if (all.length === 0) { strict: false,
console.log("No integrations found"); });
return;
}
console.log("ID\t\t\t\tName"); const db = getCliDb();
for (const i of all) { const all = await db.query.integrations.findMany();
console.log(`${i.id}\t${i.name}`);
} if (values.json) {
}, const output = all.map((i) => ({ id: i.id, name: i.name, kind: i.kind, url: i.url }));
}); console.log(JSON.stringify(output, null, 2));
return 0;
}
if (all.length === 0) {
console.log("No integrations found");
return 0;
}
printTable(
["ID", "Name", "Kind", "URL"],
all.map((i) => [i.id, i.name, i.kind, i.url]),
);
console.log(`\n${all.length} integration(s) total`);
return 0;
}
-10
View File
@@ -1,10 +0,0 @@
import { command } from "@drizzle-team/brocli";
import { integrationsDelete } from "./integrations-delete";
import { integrationsList } from "./integrations-list";
export const integrationsRoot = command({
name: "integrations",
desc: "Group of commands to manage integrations",
subcommands: [integrationsList, integrationsDelete],
});
+80 -76
View File
@@ -1,94 +1,98 @@
import { command, string } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { hashPasswordAsync } from "@homarr/auth"; import { hashPasswordAsync } from "@homarr/auth/security";
import { createId } from "@homarr/common"; import { createId } from "@homarr/common";
import { generateSecureRandomToken } from "@homarr/common/server"; import { generateSecureRandomToken } from "../utils";
import { and, count, db, eq } from "@homarr/db"; import { and, count, eq, max } from "drizzle-orm";
import { getMaxGroupPositionAsync } from "@homarr/db/queries";
import { getCliDb } from "../cli-db";
import { CliError, requireCredentialsProvider } from "../errors";
import { groupMembers, groupPermissions, groups, users } from "@homarr/db/schema"; import { groupMembers, groupPermissions, groups, users } from "@homarr/db/schema";
import { usernameSchema } from "@homarr/validation/user"; import { usernameSchema } from "@homarr/validation/user";
export const recreateAdmin = command({ export async function recreateAdminHandler(args: string[]): Promise<number> {
name: "recreate-admin", requireCredentialsProvider();
desc: "Recreate credentials admin user if none exists anymore",
options: {
username: string("username").required().alias("u").desc("Name of the admin"),
},
// eslint-disable-next-line no-restricted-syntax
handler: async (options) => {
if (!process.env.AUTH_PROVIDERS?.toLowerCase().includes("credentials")) {
console.error("Credentials provider is not enabled");
return;
}
const result = await usernameSchema.safeParseAsync(options.username); const { values } = parseArgs({
args,
options: {
username: { type: "string", short: "u" },
},
});
if (!result.success) { if (!values.username) {
console.error("Invalid username:"); throw new CliError("Missing required option: --username / -u", 2);
console.error(result.error.issues.map((error) => `- ${error.message}`).join("\n")); }
return;
}
const totalCount = await db const result = await usernameSchema.safeParseAsync(values.username);
.select({ if (!result.success) {
count: count(), const messages = result.error.issues.map((issue) => `- ${issue.message}`).join("\n");
}) throw new CliError(`Invalid username:\n${messages}`, 2);
.from(groupPermissions) }
.leftJoin(groupMembers, eq(groupMembers.groupId, groupPermissions.groupId))
.leftJoin(users, eq(users.id, groupMembers.userId))
.where(and(eq(groupPermissions.permission, "admin"), eq(users.provider, "credentials")))
.then((rows) => rows.at(0)?.count ?? 0);
if (totalCount > 0) { const db = getCliDb();
console.error("Credentials admin user exists");
return;
}
const existingUser = await db.query.users.findFirst({ const totalCount = await db
where: eq(users.name, result.data), .select({
}); count: count(),
})
.from(groupPermissions)
.leftJoin(groupMembers, eq(groupMembers.groupId, groupPermissions.groupId))
.leftJoin(users, eq(users.id, groupMembers.userId))
.where(and(eq(groupPermissions.permission, "admin"), eq(users.provider, "credentials")))
.then((rows: { count: number }[]) => rows.at(0)?.count ?? 0);
if (existingUser) { if (totalCount > 0) {
console.error("User with this name already exists"); throw new CliError("Credentials admin user exists");
return; }
}
const temporaryGroupId = createId(); const existingUser = await db.query.users.findFirst({
where: eq(users.name, result.data),
});
const maxPosition = await getMaxGroupPositionAsync(db); if (existingUser) {
await db.insert(groups).values({ throw new CliError("User with this name already exists");
id: temporaryGroupId, }
name: temporaryGroupId,
position: maxPosition + 1,
});
await db.insert(groupPermissions).values({ const temporaryGroupId = createId();
groupId: temporaryGroupId, const maxPosition = await db
permission: "admin", .select({ value: max(groups.position) })
}); .from(groups)
.then((result: { value: number | null }[]) => result[0]?.value ?? 1);
const password = generateSecureRandomToken(24); await db.insert(groups).values({
const hashedPassword = await hashPasswordAsync(password); id: temporaryGroupId,
name: temporaryGroupId,
position: maxPosition + 1,
});
const userId = createId(); await db.insert(groupPermissions).values({
await db.insert(users).values({ groupId: temporaryGroupId,
id: userId, permission: "admin",
name: result.data, });
provider: "credentials",
password: hashedPassword,
});
await db.insert(groupMembers).values({ const password = generateSecureRandomToken(24);
groupId: temporaryGroupId, const hashedPassword = await hashPasswordAsync(password);
userId, const userId = createId();
});
console.log( await db.insert(users).values({
"We created a new admin user for you. Please keep in mind, that the admin group of it has a temporary name. You should change it to something more meaningful.", id: userId,
); name: result.data,
console.log(`\tUsername: ${result.data}`); provider: "credentials",
console.log(`\tPassword: ${password}`); password: hashedPassword,
console.log(`\tGroup: ${temporaryGroupId}`); });
console.log(""); // Empty line for better readability
}, await db.insert(groupMembers).values({
}); groupId: temporaryGroupId,
userId,
});
console.log(
"We created a new admin user for you. Please keep in mind, that the admin group of it has a temporary name. You should change it to something more meaningful.",
);
console.log(`\tUsername: ${result.data}`);
console.log(`\tPassword: ${password}`);
console.log(`\tGroup: ${temporaryGroupId}`);
console.log("");
return 0;
}
+39 -37
View File
@@ -1,46 +1,48 @@
import { command, string } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { hashPasswordAsync } from "@homarr/auth"; import { hashPasswordAsync } from "@homarr/auth/security";
import { generateSecureRandomToken } from "@homarr/common/server"; import { generateSecureRandomToken } from "../utils";
import { and, db, eq } from "@homarr/db"; import { and, eq } from "drizzle-orm";
import { getCliDb } from "../cli-db";
import { CliError, requireCredentialsProvider } from "../errors";
import { sessions, users } from "@homarr/db/schema"; import { sessions, users } from "@homarr/db/schema";
export const resetPassword = command({ export async function resetPasswordHandler(args: string[]): Promise<number> {
name: "reset-password", requireCredentialsProvider();
desc: "Reset password for a user",
options: {
username: string("username").required().alias("u").desc("Name of the user"),
},
// eslint-disable-next-line no-restricted-syntax
handler: async (options) => {
if (!process.env.AUTH_PROVIDERS?.toLowerCase().includes("credentials")) {
console.error("Credentials provider is not enabled");
return;
}
const user = await db.query.users.findFirst({ const { values } = parseArgs({
where: and(eq(users.name, options.username), eq(users.provider, "credentials")), args,
}); options: {
username: { type: "string", short: "u" },
},
});
if (!user?.password) { if (!values.username) {
console.error(`User ${options.username} not found`); throw new CliError("Missing required option: --username / -u", 2);
return; }
}
// Generates a new password with 48 characters const db = getCliDb();
const newPassword = generateSecureRandomToken(24); const user = await db.query.users.findFirst({
where: and(eq(users.name, values.username), eq(users.provider, "credentials")),
});
await db if (!user?.password) {
.update(users) throw new CliError(`User ${values.username} not found`);
.set({ }
password: await hashPasswordAsync(newPassword),
})
.where(eq(users.id, user.id));
await db.delete(sessions).where(eq(sessions.userId, user.id)); const newPassword = generateSecureRandomToken(24);
console.log(`All sessions for user ${options.username} have been deleted`);
console.log("You can now login with the new password"); await db
console.log(`New password for user ${options.username}: ${newPassword}`); .update(users)
}, .set({
}); password: await hashPasswordAsync(newPassword),
})
.where(eq(users.id, user.id));
await db.delete(sessions).where(eq(sessions.userId, user.id));
console.log(`All sessions for user ${values.username} have been deleted`);
console.log("You can now login with the new password");
console.log(`New password for user ${values.username}: ${newPassword}`);
return 0;
}
+41 -33
View File
@@ -1,39 +1,47 @@
import { command, string } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { db, eq } from "@homarr/db"; import { eq } from "drizzle-orm";
import type { CliDatabase } from "../cli-db";
import { getCliDb } from "../cli-db";
import { CliError } from "../errors";
import { users } from "@homarr/db/schema"; import { users } from "@homarr/db/schema";
export const usersDelete = command({ const userLookup: Record<"id" | "username", (db: CliDatabase, value: string) => Promise<{ id: string; name: string | null } | undefined>> = {
name: "delete", id: (db, value) =>
desc: "Delete a user by id or username", db.query.users.findFirst({
options: { where: eq(users.id, value),
id: string("id").alias("i").desc("ID of the user"), }),
username: string("username").alias("u").desc("Name of the user"), username: (db, value) =>
}, db.query.users.findFirst({
// eslint-disable-next-line no-restricted-syntax where: eq(users.name, value),
handler: async (options) => { }),
if (!options.id && !options.username) { };
console.error("Either --id or --username must be provided");
return;
}
let user; export async function usersDeleteHandler(args: string[]): Promise<number> {
if (options.id) { const { values } = parseArgs({
user = await db.query.users.findFirst({ args,
where: eq(users.id, options.id), options: {
}); id: { type: "string", short: "i" },
} else if (options.username) { username: { type: "string", short: "u" },
user = await db.query.users.findFirst({ },
where: eq(users.name, options.username), });
});
}
if (!user) { const lookupKey = values.id ? "id" : values.username ? "username" : null;
console.error("User not found"); const lookupValue = values.id ?? values.username;
return;
}
await db.delete(users).where(eq(users.id, user.id)); if (!lookupKey || !lookupValue) {
console.log(`User ${user.name ?? user.id} (${user.id}) deleted`); throw new CliError("Either --id or --username must be provided", 2);
}, }
});
const db = getCliDb();
const user = await userLookup[lookupKey](db, lookupValue);
if (!user) {
throw new CliError("User not found");
}
await db.delete(users).where(eq(users.id, user.id));
console.log(`User ${user.name ?? user.id} (${user.id}) deleted`);
return 0;
}
+31 -18
View File
@@ -1,22 +1,35 @@
import { command } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { db } from "@homarr/db"; import { getCliDb } from "../cli-db";
import { printTable } from "../utils";
export const usersList = command({ export async function usersListHandler(args: string[] = []): Promise<number> {
name: "list", const { values } = parseArgs({
desc: "List all users (id, username, email)", args,
// eslint-disable-next-line no-restricted-syntax options: {
handler: async () => { json: { type: "boolean", default: false },
const allUsers = await db.query.users.findMany(); },
strict: false,
});
if (allUsers.length === 0) { const db = getCliDb();
console.log("No users found"); const allUsers = await db.query.users.findMany();
return;
}
console.log("ID\t\t\t\tUsername\tEmail"); if (values.json) {
for (const user of allUsers) { const output = allUsers.map((u) => ({ id: u.id, name: u.name, email: u.email, provider: u.provider }));
console.log(`${user.id}\t${user.name ?? ""}\t${user.email ?? ""}`); console.log(JSON.stringify(output, null, 2));
} return 0;
}, }
});
if (allUsers.length === 0) {
console.log("No users found");
return 0;
}
printTable(
["ID", "Username", "Email", "Provider"],
allUsers.map((u) => [u.id, u.name ?? "", u.email ?? "", u.provider]),
);
console.log(`\n${allUsers.length} user(s) total`);
return 0;
}
@@ -1,50 +1,66 @@
import { command, string } from "@drizzle-team/brocli"; import { parseArgs } from "node:util";
import { hashPasswordAsync } from "@homarr/auth"; import { hashPasswordAsync } from "@homarr/auth/security";
import { db, eq } from "@homarr/db"; import { eq } from "drizzle-orm";
import type { CliDatabase } from "../cli-db";
import { getCliDb } from "../cli-db";
import { CliError, requireCredentialsProvider } from "../errors";
import { sessions, users } from "@homarr/db/schema"; import { sessions, users } from "@homarr/db/schema";
export const usersUpdatePassword = command({ const userLookup: Record<
name: "update-password", "id" | "username",
desc: "Update the password for a user (credentials provider only)", (db: CliDatabase, value: string) => Promise<{ id: string; name: string | null; password: string | null } | undefined>
options: { > = {
id: string("id").alias("i").desc("ID of the user"), id: (db, value) =>
username: string("username").alias("u").desc("Name of the user"), db.query.users.findFirst({
password: string("password").alias("p").required().desc("New password"), where: eq(users.id, value),
}, }),
// eslint-disable-next-line no-restricted-syntax username: (db, value) =>
handler: async (options) => { db.query.users.findFirst({
if (!process.env.AUTH_PROVIDERS?.toLowerCase().includes("credentials")) { where: eq(users.name, value),
console.error("Credentials provider is not enabled"); }),
return; };
}
if (!options.id && !options.username) { export async function usersUpdatePasswordHandler(args: string[]): Promise<number> {
console.error("Either --id or --username must be provided"); requireCredentialsProvider();
return;
}
const user = await db.query.users.findFirst({ const { values } = parseArgs({
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion args,
where: options.id ? eq(users.id, options.id) : eq(users.name, options.username!), options: {
}); id: { type: "string", short: "i" },
username: { type: "string", short: "u" },
password: { type: "string", short: "p" },
},
});
if (!user?.password) { const lookupKey = values.id ? "id" : values.username ? "username" : null;
console.error("User not found or has no credentials record"); const lookupValue = values.id ?? values.username;
return;
}
await db if (!lookupKey || !lookupValue) {
.update(users) throw new CliError("Either --id or --username must be provided", 2);
.set({ }
password: await hashPasswordAsync(options.password),
})
.where(eq(users.id, user.id));
// invalidate existing sessions if (!values.password) {
await db.delete(sessions).where(eq(sessions.userId, user.id)); throw new CliError("Missing required option: --password / -p", 2);
console.log(`All sessions for user ${user.name ?? user.id} have been deleted`); }
console.log("Password updated successfully"); const db = getCliDb();
}, const user = await userLookup[lookupKey](db, lookupValue);
});
if (!user?.password) {
throw new CliError("User not found or has no credentials record");
}
await db
.update(users)
.set({
password: await hashPasswordAsync(values.password),
})
.where(eq(users.id, user.id));
await db.delete(sessions).where(eq(sessions.userId, user.id));
console.log(`All sessions for user ${user.name ?? user.id} have been deleted`);
console.log("Password updated successfully");
return 0;
}
-11
View File
@@ -1,11 +0,0 @@
import { command } from "@drizzle-team/brocli";
import { usersDelete } from "./users-delete";
import { usersList } from "./users-list";
import { usersUpdatePassword } from "./users-update-password";
export const usersRoot = command({
name: "users",
desc: "Group of commands to manage users",
subcommands: [usersList, usersDelete, usersUpdatePassword],
});
+16
View File
@@ -0,0 +1,16 @@
export class CliError extends Error {
constructor(
message: string,
readonly exitCode: 1 | 2 = 1,
) {
super(message);
this.name = "CliError";
}
}
export const requireCredentialsProvider = () => {
const enabled = process.env.AUTH_PROVIDERS?.toLowerCase().includes("credentials") ?? false;
if (!enabled) {
throw new CliError("Credentials provider is not enabled");
}
};
+38 -11
View File
@@ -1,14 +1,41 @@
import { run } from "@drizzle-team/brocli"; import { closeCliDbAsync } from "./cli-db";
import { CliError } from "./errors";
import { runCliAsync } from "./router";
import { fixUsernames } from "./commands/fix-usernames"; const mainAsync = async (): Promise<number> => {
import { integrationsRoot } from "./commands/integrations"; const argv = process.argv.slice(2);
import { recreateAdmin } from "./commands/recreate-admin"; const start = performance.now();
import { resetPassword } from "./commands/reset-password";
import { usersRoot } from "./commands/users";
const commands = [usersRoot, integrationsRoot, resetPassword, fixUsernames, recreateAdmin]; try {
const code = await runCliAsync(argv);
if (code === 0) {
const elapsed = Math.round(performance.now() - start);
console.error(`\nDone in ${elapsed}ms`);
}
return code;
} catch (error) {
if (error instanceof CliError) {
console.error(error.message);
return error.exitCode;
}
void run(commands, { if (error instanceof TypeError && error.message.startsWith("Unknown option")) {
name: "homarr-cli", console.error(error.message);
version: "1.0.0", return 2;
}); }
console.error(error instanceof Error ? error.message : error);
return 1;
}
};
mainAsync()
.then(async (code) => {
await closeCliDbAsync();
process.exit(code);
})
.catch(async (error) => {
console.error(error instanceof Error ? error.message : error);
await closeCliDbAsync();
process.exit(1);
});
+167
View File
@@ -0,0 +1,167 @@
import { fixUsernamesHandler } from "./commands/fix-usernames";
import { integrationsDeleteHandler } from "./commands/integrations-delete";
import { integrationsListHandler } from "./commands/integrations-list";
import { recreateAdminHandler } from "./commands/recreate-admin";
import { resetPasswordHandler } from "./commands/reset-password";
import { usersDeleteHandler } from "./commands/users-delete";
import { usersListHandler } from "./commands/users-list";
import { usersUpdatePasswordHandler } from "./commands/users-update-password";
import { CliError } from "./errors";
const VERSION = "1.0.0";
type CommandHandler = (args: string[]) => Promise<number>;
interface CommandDef {
handler: CommandHandler;
desc: string;
usage: string;
}
type CommandGroup = Record<string, CommandDef>;
const topLevelCommands: Record<string, CommandDef> = {
"reset-password": {
handler: resetPasswordHandler,
desc: "Reset password for a credentials user",
usage: "homarr reset-password -u <username>",
},
"fix-usernames": {
handler: (args) => fixUsernamesHandler(),
desc: "Lowercase all credentials usernames",
usage: "homarr fix-usernames",
},
"recreate-admin": {
handler: recreateAdminHandler,
desc: "Create credentials admin if none exists",
usage: "homarr recreate-admin -u <username>",
},
};
const commandGroups: Record<string, CommandGroup> = {
users: {
list: {
handler: (args) => usersListHandler(args),
desc: "List all users",
usage: "homarr users list [--json]",
},
delete: {
handler: usersDeleteHandler,
desc: "Delete a user by id or username",
usage: "homarr users delete --id <id> | --username <name>",
},
"update-password": {
handler: usersUpdatePasswordHandler,
desc: "Set password for a credentials user",
usage: "homarr users update-password (--id <id> | --username <name>) --password <pw>",
},
},
integrations: {
list: {
handler: (args) => integrationsListHandler(args),
desc: "List all integrations",
usage: "homarr integrations list [--json]",
},
delete: {
handler: integrationsDeleteHandler,
desc: "Delete an integration by id or name",
usage: "homarr integrations delete --id <id> | --name <name>",
},
},
};
const HELP_TEXT = `homarr-cli ${VERSION}
Usage:
homarr <command> [options]
Commands:
reset-password Reset password for a credentials user
recreate-admin Create credentials admin if none exists
fix-usernames Lowercase all credentials usernames
users list List all users
users delete Delete a user by id or username
users update-password Set password for a credentials user
integrations list List all integrations
integrations delete Delete an integration by id or name
Global Options:
-h, --help Show help (use after a command for command-specific help)
-v, --version Show CLI version
`;
const printHelp = () => {
console.log(HELP_TEXT);
};
const printCommandHelp = (def: CommandDef) => {
console.log(`${def.desc}\n`);
console.log(`Usage:\n ${def.usage}\n`);
};
const resolveHandler = (argv: string[]): { handler: CommandHandler; args: string[] } => {
const [command, subcommand, ...rest] = argv;
if (!command) {
throw new CliError("Missing command", 2);
}
const group = commandGroups[command];
if (group) {
if (!subcommand || subcommand === "--help" || subcommand === "-h") {
const subcommands = Object.entries(group)
.map(([name, def]) => ` ${name.padEnd(18)} ${def.desc}`)
.join("\n");
console.log(`Usage:\n homarr ${command} <subcommand> [options]\n\nSubcommands:\n${subcommands}\n`);
return { handler: async () => subcommand ? 0 : 2, args: [] };
}
const def = group[subcommand];
if (!def) {
throw new CliError(`Unknown subcommand "${subcommand}" for "${command}"`, 2);
}
if (hasFlag(rest, "--help", "-h")) {
printCommandHelp(def);
return { handler: async () => 0, args: [] };
}
return { handler: def.handler, args: rest };
}
const def = topLevelCommands[command];
if (!def) {
throw new CliError(`Unknown command "${command}"`, 2);
}
const args = argv.slice(1);
if (hasFlag(args, "--help", "-h")) {
printCommandHelp(def);
return { handler: async () => 0, args: [] };
}
return { handler: def.handler, args };
};
const hasFlag = (argv: string[], flag: string, short: string) =>
argv.some((arg) => arg === flag || arg === short);
export const runCliAsync = async (argv: string[]): Promise<number> => {
if (hasFlag(argv, "--help", "-h") && argv.length === 1) {
printHelp();
return 0;
}
if (hasFlag(argv, "--version", "-v")) {
console.log(VERSION);
return 0;
}
if (argv.length === 0) {
printHelp();
return 2;
}
const { handler, args } = resolveHandler(argv);
return handler(args);
};
+18
View File
@@ -0,0 +1,18 @@
import { randomBytes } from "node:crypto";
export const generateSecureRandomToken = (size: number) => randomBytes(size).toString("hex");
export const printTable = (headers: string[], rows: string[][]) => {
const widths = headers.map((h, i) =>
Math.max(h.length, ...rows.map((r) => (r[i] ?? "").length)),
);
const formatRow = (cells: string[]) =>
cells.map((cell, i) => cell.padEnd(widths[i]!)).join(" ");
console.log(formatRow(headers));
console.log(widths.map((w) => "─".repeat(w)).join(" "));
for (const row of rows) {
console.log(formatRow(row));
}
};
+4
View File
@@ -41,6 +41,10 @@ export class Stopwatch {
return dayjs().millisecond(this.startTime).fromNow(true); return dayjs().millisecond(this.startTime).fromNow(true);
} }
getElapsedInFormattedMilliseconds() {
return `${this.getElapsedInMilliseconds().toFixed(0)}ms`;
}
getElapsedInMilliseconds() { getElapsedInMilliseconds() {
return performance.now() - this.startTime; return performance.now() - this.startTime;
} }
+1
View File
@@ -14,6 +14,7 @@
"./infrastructure/db": "./src/infrastructure/db/index.ts", "./infrastructure/db": "./src/infrastructure/db/index.ts",
"./infrastructure/db/env": "./src/infrastructure/db/env.ts", "./infrastructure/db/env": "./src/infrastructure/db/env.ts",
"./infrastructure/db/constants": "./src/infrastructure/db/constants.ts", "./infrastructure/db/constants": "./src/infrastructure/db/constants.ts",
"./infrastructure/db/mapping": "./src/infrastructure/db/mapping.ts",
"./infrastructure/certificates": "./src/infrastructure/certificates/index.ts", "./infrastructure/certificates": "./src/infrastructure/certificates/index.ts",
"./infrastructure/certificates/hostnames/db/sqlite": "./src/infrastructure/certificates/hostnames/db/sqlite.ts", "./infrastructure/certificates/hostnames/db/sqlite": "./src/infrastructure/certificates/hostnames/db/sqlite.ts",
"./infrastructure/certificates/hostnames/db/mysql": "./src/infrastructure/certificates/hostnames/db/mysql.ts", "./infrastructure/certificates/hostnames/db/mysql": "./src/infrastructure/certificates/hostnames/db/mysql.ts",
+9
View File
@@ -0,0 +1,9 @@
import baseConfig from "@homarr/eslint-config/base";
/** @type {import('typescript-eslint').Config} */
export default [
{
ignores: [],
},
...baseConfig,
];
+46
View File
@@ -0,0 +1,46 @@
{
"name": "@homarr/cron-job-api",
"version": "0.1.0",
"private": true,
"license": "Apache-2.0",
"type": "module",
"exports": {
".": "./src/index.ts",
"./env": "./src/env.ts",
"./constants": "./src/constants.ts",
"./client": "./src/client.ts"
},
"typesVersions": {
"*": {
"*": [
"src/*"
]
}
},
"scripts": {
"clean": "rm -rf .turbo node_modules",
"format": "prettier --check . --ignore-path ../../.gitignore",
"lint": "eslint",
"typecheck": "tsc --noEmit"
},
"prettier": "@homarr/prettier-config",
"dependencies": {
"@homarr/common": "workspace:^0.1.0",
"@homarr/core": "workspace:^0.1.0",
"@homarr/cron-jobs": "workspace:^0.1.0",
"@tanstack/react-query": "catalog:",
"@trpc/client": "catalog:",
"@trpc/server": "catalog:",
"@trpc/tanstack-react-query": "catalog:",
"react": "catalog:",
"zod": "catalog:"
},
"devDependencies": {
"@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0",
"@types/react": "catalog:",
"eslint": "catalog:",
"typescript": "catalog:"
}
}
+20
View File
@@ -0,0 +1,20 @@
import { createTRPCClient, httpLink } from "@trpc/client";
import type { JobRouter } from ".";
import { CRON_JOB_API_KEY_HEADER, CRON_JOB_API_PATH, CRON_JOB_API_PORT } from "./constants";
import { env } from "./env";
export const cronJobApi = createTRPCClient<JobRouter>({
links: [
httpLink({
url: `${getBaseUrl()}${CRON_JOB_API_PATH}`,
headers: {
[CRON_JOB_API_KEY_HEADER]: env.CRON_JOB_API_KEY,
},
}),
],
});
function getBaseUrl() {
return `http://localhost:${CRON_JOB_API_PORT}`;
}
+3
View File
@@ -0,0 +1,3 @@
export const CRON_JOB_API_PORT = 3002;
export const CRON_JOB_API_PATH = "/trpc";
export const CRON_JOB_API_KEY_HEADER = "cron-job-api-key";
+11
View File
@@ -0,0 +1,11 @@
import { z } from "zod/v4";
import { env as commonEnv } from "@homarr/common/env";
import { createEnv } from "@homarr/core/infrastructure/env";
export const env = createEnv({
server: {
CRON_JOB_API_KEY: commonEnv.NODE_ENV === "development" ? z.string().default("test") : z.string(),
},
experimental__runtimeEnv: process.env,
});
+85
View File
@@ -0,0 +1,85 @@
import { initTRPC, TRPCError } from "@trpc/server";
import { z } from "zod/v4";
import type { JobGroupKeys } from "@homarr/cron-jobs";
import { jobGroup } from "@homarr/cron-jobs";
import { env } from "./env";
export const jobGroupKeys = jobGroup.getKeys();
export const jobNameSchema = z.enum(jobGroup.getKeys());
export interface IJobManager {
startAsync(name: JobGroupKeys): Promise<void>;
triggerAsync(name: JobGroupKeys): Promise<void>;
stop(name: JobGroupKeys): void;
updateIntervalAsync(name: JobGroupKeys, cron: string): Promise<void>;
disableAsync(name: JobGroupKeys): Promise<void>;
enableAsync(name: JobGroupKeys): Promise<void>;
getAllAsync(): Promise<
{
name: JobGroupKeys;
cron: string;
preventManualExecution: boolean;
preventCustomInterval: boolean;
isEnabled: boolean;
}[]
>;
}
const t = initTRPC
.context<{
manager: IJobManager;
apiKey?: string;
}>()
.create();
const createTrpcRouter = t.router;
const apiKeyProcedure = t.procedure.use(({ ctx, next }) => {
if (ctx.apiKey !== env.CRON_JOB_API_KEY) {
throw new TRPCError({
code: "FORBIDDEN",
message: "Missing or invalid API key",
});
}
return next({
ctx: {
...ctx,
apiKey: undefined, // Clear the API key after checking
},
});
});
export const jobRouter = createTrpcRouter({
start: apiKeyProcedure.input(jobNameSchema).mutation(async ({ input, ctx }) => {
await ctx.manager.startAsync(input);
}),
trigger: apiKeyProcedure.input(jobNameSchema).mutation(async ({ input, ctx }) => {
await ctx.manager.triggerAsync(input);
}),
stop: apiKeyProcedure.input(jobNameSchema).mutation(({ input, ctx }) => {
ctx.manager.stop(input);
}),
updateInterval: apiKeyProcedure
.input(
z.object({
name: jobNameSchema,
cron: z.string(),
}),
)
.mutation(async ({ input, ctx }) => {
await ctx.manager.updateIntervalAsync(input.name, input.cron);
}),
disable: apiKeyProcedure.input(jobNameSchema).mutation(async ({ input, ctx }) => {
await ctx.manager.disableAsync(input);
}),
enable: apiKeyProcedure.input(jobNameSchema).mutation(async ({ input, ctx }) => {
await ctx.manager.enableAsync(input);
}),
getAll: apiKeyProcedure.query(({ ctx }) => {
return ctx.manager.getAllAsync();
}),
});
export type JobRouter = typeof jobRouter;
+8
View File
@@ -0,0 +1,8 @@
{
"extends": "@homarr/tsconfig/base.json",
"compilerOptions": {
"tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
},
"include": ["*.ts", "src"],
"exclude": ["node_modules"]
}
+1 -2
View File
@@ -27,13 +27,12 @@
"@homarr/common": "workspace:^0.1.0", "@homarr/common": "workspace:^0.1.0",
"@homarr/core": "workspace:^", "@homarr/core": "workspace:^",
"@homarr/db": "workspace:^0.1.0", "@homarr/db": "workspace:^0.1.0",
"node-cron": "catalog:" "croner": "catalog:"
}, },
"devDependencies": { "devDependencies": {
"@homarr/eslint-config": "workspace:^0.2.0", "@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0", "@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0", "@homarr/tsconfig": "workspace:^0.1.0",
"@types/node-cron": "catalog:",
"eslint": "catalog:", "eslint": "catalog:",
"typescript": "catalog:" "typescript": "catalog:"
} }
+11 -12
View File
@@ -1,4 +1,4 @@
import { createTask, validate } from "node-cron"; import { Cron } from "croner";
import { Stopwatch } from "@homarr/common"; import { Stopwatch } from "@homarr/common";
import type { MaybePromise } from "@homarr/common/types"; import type { MaybePromise } from "@homarr/common/types";
@@ -83,10 +83,15 @@ const createCallback = <TAllowedNames extends string, TName extends TAllowedName
? defaultCronExpression ? defaultCronExpression
: (configuration?.cronExpression ?? defaultCronExpression); : (configuration?.cronExpression ?? defaultCronExpression);
const scheduledTask = createTask(cronExpression, () => void catchingCallbackAsync(), { const scheduledTask = new Cron(
name, cronExpression,
timezone: creatorOptions.timezone, {
}); name,
timezone: creatorOptions.timezone,
paused: true,
},
() => void catchingCallbackAsync(),
);
creatorOptions.logger.logDebug("The scheduled task for cron job was created", { creatorOptions.logger.logDebug("The scheduled task for cron job was created", {
name, name,
cronExpression: defaultCronExpression, cronExpression: defaultCronExpression,
@@ -116,6 +121,7 @@ const createCallback = <TAllowedNames extends string, TName extends TAllowedName
}, },
preventManualExecution: options.preventManualExecution ?? false, preventManualExecution: options.preventManualExecution ?? false,
preventCustomInterval: options.preventCustomInterval ?? false, preventCustomInterval: options.preventCustomInterval ?? false,
timezone: creatorOptions.timezone,
}; };
}; };
}; };
@@ -132,13 +138,6 @@ export const createCronJobCreator = <TAllowedNames extends string = string>(
defaultCronExpression: TExpression, defaultCronExpression: TExpression,
options: CreateCronJobOptions = { runOnStart: false }, options: CreateCronJobOptions = { runOnStart: false },
) => { ) => {
creatorOptions.logger.logDebug("Validating cron expression for cron job", {
name,
cronExpression: defaultCronExpression,
});
if (!validate(defaultCronExpression)) {
throw new Error(`Invalid cron expression '${defaultCronExpression}' for job '${name}'`);
}
creatorOptions.logger.logDebug("Cron job expression for cron job is valid", { creatorOptions.logger.logDebug("Cron job expression for cron job is valid", {
name, name,
cronExpression: defaultCronExpression, cronExpression: defaultCronExpression,
+11 -11
View File
@@ -1,4 +1,4 @@
import type { ScheduledTask } from "node-cron"; import type { Cron } from "croner";
import { objectEntries, objectKeys } from "@homarr/common"; import { objectEntries, objectKeys } from "@homarr/common";
import { db } from "@homarr/db"; import { db } from "@homarr/db";
@@ -34,7 +34,7 @@ export const createJobGroupCreator = <TAllowedNames extends string = string>(
}); });
} }
const tasks = new Map<string, ScheduledTask>(); const tasks = new Map<string, Cron>();
return { return {
initializeAsync: async () => { initializeAsync: async () => {
@@ -62,7 +62,7 @@ export const createJobGroupCreator = <TAllowedNames extends string = string>(
name: job.name, name: job.name,
}); });
await job.onStartAsync(); await job.onStartAsync();
await tasks.get(name as string)?.start(); tasks.get(name as string)?.resume();
}, },
startAllAsync: async () => { startAllAsync: async () => {
for (const job of jobRegistry.values()) { for (const job of jobRegistry.values()) {
@@ -74,7 +74,7 @@ export const createJobGroupCreator = <TAllowedNames extends string = string>(
name: job.name, name: job.name,
}); });
await job.onStartAsync(); await job.onStartAsync();
await tasks.get(job.name)?.start(); tasks.get(job.name)?.resume();
} }
}, },
runManuallyAsync: async (name: keyof TJobs) => { runManuallyAsync: async (name: keyof TJobs) => {
@@ -87,23 +87,23 @@ export const createJobGroupCreator = <TAllowedNames extends string = string>(
options.logger.logInfo("Running schedule cron job manually.", { options.logger.logInfo("Running schedule cron job manually.", {
name: job.name, name: job.name,
}); });
await tasks.get(name as string)?.execute(); await tasks.get(name as string)?.trigger();
}, },
stopAsync: async (name: keyof TJobs) => { stop: (name: keyof TJobs) => {
const job = jobRegistry.get(name as string); const job = jobRegistry.get(name as string);
if (!job) return; if (!job) return;
options.logger.logInfo("Stopping schedule of cron job.", { options.logger.logInfo("Stopping schedule of cron job.", {
name: job.name, name: job.name,
}); });
await tasks.get(name as string)?.stop(); tasks.get(name as string)?.pause();
}, },
stopAllAsync: async () => { stopAll: () => {
for (const job of jobRegistry.values()) { for (const job of jobRegistry.values()) {
options.logger.logInfo("Stopping schedule of cron job.", { options.logger.logInfo("Stopping schedule of cron job.", {
name: job.name, name: job.name,
}); });
await tasks.get(job.name)?.stop(); tasks.get(job.name)?.pause();
} }
}, },
getJobRegistry() { getJobRegistry() {
@@ -112,8 +112,8 @@ export const createJobGroupCreator = <TAllowedNames extends string = string>(
getTask(name: keyof TJobs) { getTask(name: keyof TJobs) {
return tasks.get(name as string) ?? null; return tasks.get(name as string) ?? null;
}, },
setTask(name: keyof TJobs, task: ScheduledTask) { setTask(name: keyof TJobs, cron: Cron) {
tasks.set(name as string, task); tasks.set(name as string, cron);
}, },
getKeys() { getKeys() {
return objectKeys(jobs); return objectKeys(jobs);
+2 -6
View File
@@ -5,8 +5,7 @@
"license": "Apache-2.0", "license": "Apache-2.0",
"type": "module", "type": "module",
"exports": { "exports": {
".": "./index.ts", ".": "./index.ts"
"./job-manager": "./src/job-manager.ts"
}, },
"typesVersions": { "typesVersions": {
"*": { "*": {
@@ -39,15 +38,12 @@
"@homarr/server-settings": "workspace:^0.1.0", "@homarr/server-settings": "workspace:^0.1.0",
"@homarr/translation": "workspace:^0.1.0", "@homarr/translation": "workspace:^0.1.0",
"@homarr/validation": "workspace:^0.1.0", "@homarr/validation": "workspace:^0.1.0",
"node-cron": "catalog:", "semver-parser": "catalog:"
"semver-parser": "catalog:",
"zod": "catalog:"
}, },
"devDependencies": { "devDependencies": {
"@homarr/eslint-config": "workspace:^0.2.0", "@homarr/eslint-config": "workspace:^0.2.0",
"@homarr/prettier-config": "workspace:^0.1.0", "@homarr/prettier-config": "workspace:^0.1.0",
"@homarr/tsconfig": "workspace:^0.1.0", "@homarr/tsconfig": "workspace:^0.1.0",
"@types/node-cron": "catalog:",
"eslint": "catalog:", "eslint": "catalog:",
"typescript": "catalog:" "typescript": "catalog:"
} }
+30 -40
View File
@@ -20,6 +20,7 @@ import { networkControllerJob } from "./jobs/integrations/network-controller";
import { refreshNotificationsJob } from "./jobs/integrations/notifications"; import { refreshNotificationsJob } from "./jobs/integrations/notifications";
import { timetableJob } from "./jobs/integrations/timetable"; import { timetableJob } from "./jobs/integrations/timetable";
import { tracearrJob } from "./jobs/integrations/tracearr"; import { tracearrJob } from "./jobs/integrations/tracearr";
import { umamiActiveVisitorsJob } from "./jobs/integrations/umami";
import { minecraftServerStatusJob } from "./jobs/minecraft-server-status"; import { minecraftServerStatusJob } from "./jobs/minecraft-server-status";
import { pingJob } from "./jobs/ping"; import { pingJob } from "./jobs/ping";
import { rssFeedsJob } from "./jobs/rss-feeds"; import { rssFeedsJob } from "./jobs/rss-feeds";
@@ -27,45 +28,34 @@ import { updateCheckerJob } from "./jobs/update-checker";
import { weatherJob } from "./jobs/weather"; import { weatherJob } from "./jobs/weather";
import { createCronJobGroup } from "./lib"; import { createCronJobGroup } from "./lib";
const getJobGroup = () => { export const jobGroup = createCronJobGroup({
return createCronJobGroup({ analytics: analyticsJob,
analytics: analyticsJob, iconsUpdater: iconsUpdaterJob,
iconsUpdater: iconsUpdaterJob, ping: pingJob,
ping: pingJob, smartHomeEntityState: smartHomeEntityStateJob,
smartHomeEntityState: smartHomeEntityStateJob, mediaServer: mediaServerJob,
mediaServer: mediaServerJob, mediaOrganizer: mediaOrganizerJob,
mediaOrganizer: mediaOrganizerJob, downloads: downloadsJob,
downloads: downloadsJob, dnsHole: dnsHoleJob,
dnsHole: dnsHoleJob, mediaRequestStats: mediaRequestStatsJob,
mediaRequestStats: mediaRequestStatsJob, mediaRequestList: mediaRequestListJob,
mediaRequestList: mediaRequestListJob, rssFeeds: rssFeedsJob,
rssFeeds: rssFeedsJob, indexerManager: indexerManagerJob,
indexerManager: indexerManagerJob, healthMonitoring: healthMonitoringJob,
healthMonitoring: healthMonitoringJob, updateChecker: updateCheckerJob,
updateChecker: updateCheckerJob, mediaTranscoding: mediaTranscodingJob,
mediaTranscoding: mediaTranscodingJob, minecraftServerStatus: minecraftServerStatusJob,
minecraftServerStatus: minecraftServerStatusJob, dockerContainers: dockerContainersJob,
dockerContainers: dockerContainersJob, networkController: networkControllerJob,
networkController: networkControllerJob, firewallCpu: firewallCpuJob,
firewallCpu: firewallCpuJob, firewallMemory: firewallMemoryJob,
firewallMemory: firewallMemoryJob, firewallVersion: firewallVersionJob,
firewallVersion: firewallVersionJob, firewallInterfaces: firewallInterfacesJob,
firewallInterfaces: firewallInterfacesJob, refreshNotifications: refreshNotificationsJob,
refreshNotifications: refreshNotificationsJob, weather: weatherJob,
weather: weatherJob, timetable: timetableJob,
timetable: timetableJob, tracearr: tracearrJob,
tracearr: tracearrJob, umamiActiveVisitors: umamiActiveVisitorsJob,
}); });
};
// Add global type augmentation for homarr
declare global {
var cronJobs: ReturnType<typeof getJobGroup> | undefined;
}
global.cronJobs ??= getJobGroup();
export const jobGroup = global.cronJobs;
export type JobGroupKeys = ReturnType<(typeof jobGroup)["getKeys"]>[number]; export type JobGroupKeys = ReturnType<(typeof jobGroup)["getKeys"]>[number];
export * from "./schemas";
+39 -47
View File
@@ -1,9 +1,12 @@
import type { MySqlRawQueryResult } from "drizzle-orm/mysql2";
import type { QueryResult } from "pg";
import { createId, splitToNChunks, Stopwatch } from "@homarr/common"; import { createId, splitToNChunks, Stopwatch } from "@homarr/common";
import { env } from "@homarr/common/env"; import { env } from "@homarr/common/env";
import { createLogger } from "@homarr/core/infrastructure/logs"; import { createLogger } from "@homarr/core/infrastructure/logs";
import { EVERY_WEEK } from "@homarr/cron-jobs-core/expressions"; import { EVERY_WEEK } from "@homarr/cron-jobs-core/expressions";
import type { InferInsertModel } from "@homarr/db"; import type { InferInsertModel } from "@homarr/db";
import { db, handleTransactionsAsync, inArray, sql } from "@homarr/db"; import { and, db, eq, handleTransactionsAsync, inArray, notInArray, or } from "@homarr/db";
import { iconRepositories, icons } from "@homarr/db/schema"; import { iconRepositories, icons } from "@homarr/db/schema";
import { fetchIconsAsync } from "@homarr/icons"; import { fetchIconsAsync } from "@homarr/icons";
@@ -26,7 +29,7 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
logger.info("Fetched icons from repositories", { logger.info("Fetched icons from repositories", {
repositoryCount: repositoryIconGroups.length, repositoryCount: repositoryIconGroups.length,
iconCount: countIcons, iconCount: countIcons,
duration: stopWatch.getElapsedInHumanWords(), duration: stopWatch.getElapsedInFormattedMilliseconds(),
}); });
const databaseIconRepositories = await db.query.iconRepositories.findMany({ const databaseIconRepositories = await db.query.iconRepositories.findMany({
@@ -35,7 +38,7 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
}, },
}); });
const skippedChecksums: `${string}.${string}`[] = []; const skippedChecksums = new Map<string, string[]>();
let countDeleted = 0; let countDeleted = 0;
let countInserted = 0; let countInserted = 0;
@@ -50,6 +53,7 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
if (!repositoryIconGroup.success) { if (!repositoryIconGroup.success) {
continue; continue;
} }
const localSkippedChecksums: string[] = [];
const repositoryInDb = databaseIconRepositories.find( const repositoryInDb = databaseIconRepositories.find(
(dbIconGroup) => dbIconGroup.slug === repositoryIconGroup.slug, (dbIconGroup) => dbIconGroup.slug === repositoryIconGroup.slug,
@@ -66,7 +70,7 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
for (const icon of repositoryIconGroup.icons) { for (const icon of repositoryIconGroup.icons) {
if (dbIconsInRepository.some((dbIcon) => dbIcon.checksum === icon.checksum)) { if (dbIconsInRepository.some((dbIcon) => dbIcon.checksum === icon.checksum)) {
skippedChecksums.push(`${iconRepositoryId}.${icon.checksum}`); localSkippedChecksums.push(icon.checksum);
continue; continue;
} }
@@ -79,38 +83,28 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
}); });
countInserted++; countInserted++;
} }
}
const deadIcons = allDbIcons.filter( skippedChecksums.set(iconRepositoryId, localSkippedChecksums);
(icon) => !skippedChecksums.includes(`${icon.iconRepositoryId}.${icon.checksum}`), }
);
const deadIconRepositories = databaseIconRepositories.filter( const deadIconRepositories = databaseIconRepositories.filter(
(iconRepository) => !repositoryIconGroups.some((group) => group.slug === iconRepository.slug), (iconRepository) => !repositoryIconGroups.some((group) => group.slug === iconRepository.slug),
); );
const deadIconsFilter = or(
...[...skippedChecksums.entries()].map(([iconRepositoryId, checksums]) =>
and(eq(icons.iconRepositoryId, iconRepositoryId), notInArray(icons.checksum, checksums)),
),
);
await handleTransactionsAsync(db, { await handleTransactionsAsync(db, {
async handleAsync(db, schema) { async handleAsync(db, schema) {
await db.transaction(async (transaction) => { await db.transaction(async (transaction) => {
if (newIconRepositories.length >= 1) { const result = (await transaction.delete(schema.icons).where(deadIconsFilter)) as
await transaction.insert(schema.iconRepositories).values(newIconRepositories); | MySqlRawQueryResult
} | QueryResult;
if (newIcons.length >= 1) { countDeleted += Array.isArray(result) ? result[0].affectedRows : (result.rowCount ?? 0);
// We only insert 5000 icons at a time to avoid SQLite limitations
for (const chunck of splitToNChunks(newIcons, Math.ceil(newIcons.length / 5000))) {
await transaction.insert(schema.icons).values(chunck);
}
}
if (deadIcons.length >= 1) {
await transaction.delete(schema.icons).where(
inArray(
// Combine iconRepositoryId and checksum to allow same icons on different repositories
sql`concat(${icons.iconRepositoryId}, '.', ${icons.checksum})`,
deadIcons.map((icon) => `${icon.iconRepositoryId}.${icon.checksum}`),
),
);
}
if (deadIconRepositories.length >= 1) { if (deadIconRepositories.length >= 1) {
await transaction.delete(schema.iconRepositories).where( await transaction.delete(schema.iconRepositories).where(
@@ -121,33 +115,22 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
); );
} }
countDeleted += deadIcons.length;
});
},
handleSync() {
db.transaction((transaction) => {
if (newIconRepositories.length >= 1) { if (newIconRepositories.length >= 1) {
transaction.insert(iconRepositories).values(newIconRepositories).run(); await transaction.insert(schema.iconRepositories).values(newIconRepositories);
} }
if (newIcons.length >= 1) { if (newIcons.length >= 1) {
// We only insert 5000 icons at a time to avoid SQLite limitations // We only insert 5000 icons at a time to avoid SQLite limitations
for (const chunck of splitToNChunks(newIcons, Math.ceil(newIcons.length / 5000))) { for (const chunck of splitToNChunks(newIcons, Math.ceil(newIcons.length / 5000))) {
transaction.insert(icons).values(chunck).run(); await transaction.insert(schema.icons).values(chunck);
} }
} }
if (deadIcons.length >= 1) { });
transaction },
.delete(icons) handleSync() {
.where( db.transaction((transaction) => {
inArray( const result = transaction.delete(icons).where(deadIconsFilter).run();
// Combine iconRepositoryId and checksum to allow same icons on different repositories countDeleted += result.changes;
sql`concat(${icons.iconRepositoryId}, '.', ${icons.checksum})`,
deadIcons.map((icon) => `${icon.iconRepositoryId}.${icon.checksum}`),
),
)
.run();
}
if (deadIconRepositories.length >= 1) { if (deadIconRepositories.length >= 1) {
transaction transaction
@@ -161,13 +144,22 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
.run(); .run();
} }
countDeleted += deadIcons.length; if (newIconRepositories.length >= 1) {
transaction.insert(iconRepositories).values(newIconRepositories).run();
}
if (newIcons.length >= 1) {
// We only insert 5000 icons at a time to avoid SQLite limitations
for (const chunck of splitToNChunks(newIcons, Math.ceil(newIcons.length / 5000))) {
transaction.insert(icons).values(chunck).run();
}
}
}); });
}, },
}); });
logger.info("Updated icons in database", { logger.info("Updated icons in database", {
duration: stopWatch.getElapsedInHumanWords(), duration: stopWatch.getElapsedInFormattedMilliseconds(),
added: countInserted, added: countInserted,
deleted: countDeleted, deleted: countDeleted,
}); });
@@ -0,0 +1,14 @@
import { EVERY_30_SECONDS } from "@homarr/cron-jobs-core/expressions";
import { createRequestIntegrationJobHandler } from "@homarr/request-handler/lib/cached-request-integration-job-handler";
import { umamiActiveVisitorsRequestHandler } from "@homarr/request-handler/umami";
import { createCronJob } from "../../lib";
export const umamiActiveVisitorsJob = createCronJob("umamiActiveVisitors", EVERY_30_SECONDS).withCallback(
createRequestIntegrationJobHandler(umamiActiveVisitorsRequestHandler.handler, {
widgetKinds: ["umami"],
getInput: {
umami: (options) => (options.websiteId ? { websiteId: options.websiteId } : []),
},
}),
);
-6
View File
@@ -1,6 +0,0 @@
import { validate } from "node-cron";
import z from "zod";
export const cronExpressionSchema = z.string().refine((expression) => validate(expression), {
error: "Invalid cron expression",
});
@@ -0,0 +1 @@
ALTER TABLE `user` ADD `ddg_bangs` boolean DEFAULT true NOT NULL;
File diff suppressed because it is too large. Load diff
@@ -267,6 +267,13 @@
"when": 1775399941430, "when": 1775399941430,
"tag": "0037_remove_salt", "tag": "0037_remove_salt",
"breakpoints": true "breakpoints": true
},
{
"idx": 38,
"version": "5",
"when": 1775400000000,
"tag": "0038_add_user_ddg_bangs",
"breakpoints": true
} }
] ]
} }
@@ -0,0 +1 @@
ALTER TABLE "user" ADD COLUMN "ddg_bangs" boolean DEFAULT true NOT NULL;
File diff suppressed because it is too large. Load diff
@@ -29,6 +29,13 @@
"when": 1775399963041, "when": 1775399963041,
"tag": "0003_remove_salt", "tag": "0003_remove_salt",
"breakpoints": true "breakpoints": true
},
{
"idx": 4,
"version": "7",
"when": 1775400000000,
"tag": "0004_add_user_ddg_bangs",
"breakpoints": true
} }
] ]
} }
+3 -1
View File
@@ -4,6 +4,7 @@ import {
everyoneGroup, everyoneGroup,
getIntegrationDefaultUrl, getIntegrationDefaultUrl,
getIntegrationName, getIntegrationName,
integrationDefs,
integrationKinds, integrationKinds,
} from "@homarr/definitions"; } from "@homarr/definitions";
import { defaultServerSettings, defaultServerSettingsKeys } from "@homarr/server-settings"; import { defaultServerSettings, defaultServerSettingsKeys } from "@homarr/server-settings";
@@ -143,8 +144,9 @@ const seedDefaultIntegrationsAsync = async (db: Database) => {
const defaultIntegrations = integrationKinds.reduce<Integration[]>((acc, kind) => { const defaultIntegrations = integrationKinds.reduce<Integration[]>((acc, kind) => {
const name = getIntegrationName(kind); const name = getIntegrationName(kind);
const defaultUrl = getIntegrationDefaultUrl(kind); const defaultUrl = getIntegrationDefaultUrl(kind);
const hasNoAuthOption = integrationDefs[kind].secretKinds.some((kinds) => kinds.length === 0);
if (defaultUrl !== undefined) { if (defaultUrl !== undefined && hasNoAuthOption) {
acc.push({ acc.push({
id: "new", id: "new",
name: `${name} Default`, name: `${name} Default`,
@@ -0,0 +1 @@
ALTER TABLE `user` ADD `ddg_bangs` integer DEFAULT true NOT NULL;
File diff suppressed because it is too large. Load diff
@@ -253,6 +253,13 @@
"when": 1775399918831, "when": 1775399918831,
"tag": "0035_remove_salt", "tag": "0035_remove_salt",
"breakpoints": true "breakpoints": true
},
{
"idx": 36,
"version": "6",
"when": 1775400000000,
"tag": "0036_add_user_ddg_bangs",
"breakpoints": true
} }
] ]
} }
+2
View File
@@ -37,6 +37,8 @@
"push:sqlite": "pnpm with-env drizzle-kit push --config ./configs/sqlite.config.ts", "push:sqlite": "pnpm with-env drizzle-kit push --config ./configs/sqlite.config.ts",
"seed": "pnpm with-env tsx ./migrations/run-seed.ts", "seed": "pnpm with-env tsx ./migrations/run-seed.ts",
"studio": "pnpm with-env drizzle-kit studio --config ./configs/sqlite.config.ts", "studio": "pnpm with-env drizzle-kit studio --config ./configs/sqlite.config.ts",
"studio:mysql": "pnpm with-env drizzle-kit studio --config ./configs/mysql.config.ts",
"studio:postgresql": "pnpm with-env drizzle-kit studio --config ./configs/postgresql.config.ts",
"typecheck": "tsc --noEmit", "typecheck": "tsc --noEmit",
"with-env": "dotenv -e ../../.env --" "with-env": "dotenv -e ../../.env --"
}, },
+1 -1
View File
@@ -1,6 +1,6 @@
import type { InferSelectModel } from "drizzle-orm"; import type { InferSelectModel } from "drizzle-orm";
import { createSchema } from "@homarr/core/infrastructure/db"; import { createDbMapping as createSchema } from "@homarr/core/infrastructure/db/mapping";
import * as mysqlSchema from "./mysql"; import * as mysqlSchema from "./mysql";
import * as pgSchema from "./postgresql"; import * as pgSchema from "./postgresql";
+1
View File
@@ -76,6 +76,7 @@ export const users = mysqlTable("user", {
onDelete: "set null", onDelete: "set null",
}), }),
openSearchInNewTab: boolean().default(false).notNull(), openSearchInNewTab: boolean().default(false).notNull(),
ddgBangs: boolean().default(true).notNull(),
colorScheme: varchar({ length: 5 }).$type<ColorScheme>().default("dark").notNull(), colorScheme: varchar({ length: 5 }).$type<ColorScheme>().default("dark").notNull(),
firstDayOfWeek: tinyint().$type<DayOfWeek>().default(1).notNull(), // Defaults to Monday firstDayOfWeek: tinyint().$type<DayOfWeek>().default(1).notNull(), // Defaults to Monday
pingIconsEnabled: boolean().default(false).notNull(), pingIconsEnabled: boolean().default(false).notNull(),
+1
View File
@@ -75,6 +75,7 @@ export const users = pgTable("user", {
onDelete: "set null", onDelete: "set null",
}), }),
openSearchInNewTab: boolean().default(false).notNull(), openSearchInNewTab: boolean().default(false).notNull(),
ddgBangs: boolean().default(true).notNull(),
colorScheme: varchar({ length: 5 }).$type<ColorScheme>().default("dark").notNull(), colorScheme: varchar({ length: 5 }).$type<ColorScheme>().default("dark").notNull(),
firstDayOfWeek: smallint().$type<DayOfWeek>().default(1).notNull(), // Defaults to Monday firstDayOfWeek: smallint().$type<DayOfWeek>().default(1).notNull(), // Defaults to Monday
pingIconsEnabled: boolean().default(false).notNull(), pingIconsEnabled: boolean().default(false).notNull(),
+1
View File
@@ -58,6 +58,7 @@ export const users = sqliteTable("user", {
onDelete: "set null", onDelete: "set null",
}), }),
openSearchInNewTab: int({ mode: "boolean" }).default(true).notNull(), openSearchInNewTab: int({ mode: "boolean" }).default(true).notNull(),
ddgBangs: int({ mode: "boolean" }).default(true).notNull(),
colorScheme: text().$type<ColorScheme>().default("dark").notNull(), colorScheme: text().$type<ColorScheme>().default("dark").notNull(),
firstDayOfWeek: int().$type<DayOfWeek>().default(1).notNull(), // Defaults to Monday firstDayOfWeek: int().$type<DayOfWeek>().default(1).notNull(), // Defaults to Monday
pingIconsEnabled: int({ mode: "boolean" }).default(false).notNull(), pingIconsEnabled: int({ mode: "boolean" }).default(false).notNull(),
+11 -1
View File
@@ -61,7 +61,7 @@ export const integrationDefs = {
}, },
qBittorrent: { qBittorrent: {
name: "qBittorrent", name: "qBittorrent",
secretKinds: [["username", "password"]], secretKinds: [["apiKey"], ["username", "password"]],
iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/qbittorrent.svg", iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/qbittorrent.svg",
category: ["downloadClient", "torrent"], category: ["downloadClient", "torrent"],
documentationUrl: createDocumentationLink("/docs/integrations/q-bittorent"), documentationUrl: createDocumentationLink("/docs/integrations/q-bittorent"),
@@ -370,6 +370,15 @@ export const integrationDefs = {
category: ["speedtest"], category: ["speedtest"],
documentationUrl: createDocumentationLink("/docs/integrations/speedtest-tracker"), documentationUrl: createDocumentationLink("/docs/integrations/speedtest-tracker"),
}, },
umami: {
name: "Umami",
secretKinds: [["username", "password"], ["apiKey"]],
iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/umami.svg",
category: ["analytics"],
defaultUrl: "https://api.umami.is/v1",
// @ts-expect-error - docs page will be created when integration is merged
documentationUrl: createDocumentationLink("/docs/integrations/umami"),
},
// This integration only returns mock data, it is used during development (but can also be used in production by directly going to the create page) // This integration only returns mock data, it is used during development (but can also be used in production by directly going to the create page)
mock: { mock: {
name: "Mock", name: "Mock",
@@ -461,6 +470,7 @@ export const integrationCategories = [
"notes", "notes",
"mediaMonitoring", "mediaMonitoring",
"speedtest", "speedtest",
"analytics",
] as const; ] as const;
export type IntegrationCategory = (typeof integrationCategories)[number]; export type IntegrationCategory = (typeof integrationCategories)[number];
+1 -1
View File
@@ -1,2 +1,2 @@
export const colorSchemes = ["light", "dark"] as const; export const colorSchemes = ["auto", "light", "dark"] as const;
export type ColorScheme = (typeof colorSchemes)[number]; export type ColorScheme = (typeof colorSchemes)[number];
Loaded 100 of 201 files, more files were not shown because too many files have changed in this diff. Show more