Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4ab9f25274 |
No files matched your search
+2
-2
@@ -58,8 +58,8 @@ TURBO_TELEMETRY_DISABLED=1
|
|||||||
# Enable kubernetes tool
|
# Enable kubernetes tool
|
||||||
# ENABLE_KUBERNETES=true
|
# ENABLE_KUBERNETES=true
|
||||||
|
|
||||||
# Enable mock integration
|
# Enable the development-only mock integration. Never enable this in production.
|
||||||
UNSAFE_ENABLE_MOCK_INTEGRATION=true
|
# UNSAFE_ENABLE_MOCK_INTEGRATION=true
|
||||||
|
|
||||||
# Public URL contract. Values must be absolute HTTP(S) URLs without credentials,
|
# Public URL contract. Values must be absolute HTTP(S) URLs without credentials,
|
||||||
# query strings, or fragments. Trailing slashes are normalized at startup.
|
# query strings, or fragments. Trailing slashes are normalized at startup.
|
||||||
|
|||||||
@@ -133,9 +133,10 @@ External redis is currently not supported with Proxmox Community Scripts
|
|||||||
The advanced deployments environment variables should only be used if you know what you are doing.
|
The advanced deployments environment variables should only be used if you know what you are doing.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
| Environment Variable | Description |
|
| Environment Variable | Description | Default |
|
||||||
| ------------------------ | --------------------------------------------------- |
|
| -------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------- |
|
||||||
| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
|
| `DB_MIGRATIONS_DISABLED` | Disable database migrations. For example, when migrations are managed separately in Helm deployments. | `false` |
|
||||||
|
| `UNSAFE_ENABLE_MOCK_INTEGRATION` | Enable the development-only Mock integration. This exposes fabricated data and must not be used in production. | `false` |
|
||||||
|
|
||||||
All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
|
All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
|
||||||
trailing slashes when Homarr or Docusaurus starts.
|
trailing slashes when Homarr or Docusaurus starts.
|
||||||
@@ -47,6 +47,9 @@ export default async function IntegrationsNewPage(props: NewIntegrationPageProps
|
|||||||
const tCreate = await getI18n("integration.page.create");
|
const tCreate = await getI18n("integration.page.create");
|
||||||
|
|
||||||
const currentKind = result.data;
|
const currentKind = result.data;
|
||||||
|
if (currentKind === "mock" && !env.UNSAFE_ENABLE_MOCK_INTEGRATION) {
|
||||||
|
notFound();
|
||||||
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
|
|||||||
+8
-8
@@ -74,7 +74,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/archiveteam-warrior" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png" alt="ArchiveTeam Warrior" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png" alt="ArchiveTeam Warrior" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">ArchiveTeam<br/>Warrior</p>
|
<p align="center">ArchiveTeam<br/>Warrior</p>
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/audiobookshelf" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/audiobookshelf.svg" alt="Audiobookshelf" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/audiobookshelf.svg" alt="Audiobookshelf" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Audiobookshelf</p>
|
<p align="center">Audiobookshelf</p>
|
||||||
@@ -137,7 +137,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/glances" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/glances.svg" alt="Glances" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/glances.svg" alt="Glances" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Glances</p>
|
<p align="center">Glances</p>
|
||||||
@@ -200,7 +200,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/navidrome" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/navidrome.svg" alt="Navidrome" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/navidrome.svg" alt="Navidrome" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Navidrome</p>
|
<p align="center">Navidrome</p>
|
||||||
@@ -249,7 +249,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/paperless-ngx" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/paperless-ngx.svg" alt="Paperless-ngx" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/paperless-ngx.svg" alt="Paperless-ngx" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Paperless-ngx</p>
|
<p align="center">Paperless-ngx</p>
|
||||||
@@ -263,7 +263,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/peanut" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/peanut.svg" alt="PeaNUT" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/peanut.svg" alt="PeaNUT" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">PeaNUT</p>
|
<p align="center">PeaNUT</p>
|
||||||
@@ -313,7 +313,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener">
|
<a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@main/png/readarr.png" alt="Readarr" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/readarr.svg" alt="Readarr" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Readarr</p>
|
<p align="center">Readarr</p>
|
||||||
</a>
|
</a>
|
||||||
@@ -424,7 +424,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/uptime-kuma" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/uptime-kuma.svg" alt="Uptime Kuma" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/uptime-kuma.svg" alt="Uptime Kuma" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Uptime<br/>Kuma</p>
|
<p align="center">Uptime<br/>Kuma</p>
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ const publicHttpUrl = (variableName: string) =>
|
|||||||
export const env = createEnv({
|
export const env = createEnv({
|
||||||
server: {
|
server: {
|
||||||
KUBERNETES_SERVICE_ACCOUNT_NAME: z.string().optional(),
|
KUBERNETES_SERVICE_ACCOUNT_NAME: z.string().optional(),
|
||||||
|
UNSAFE_ENABLE_MOCK_INTEGRATION: createBooleanSchema(false),
|
||||||
DEMO_MODE: createBooleanSchema(false),
|
DEMO_MODE: createBooleanSchema(false),
|
||||||
DEMO_READ_ONLY: createBooleanSchema(true),
|
DEMO_READ_ONLY: createBooleanSchema(true),
|
||||||
HOMARR_WEBSITE_URL: publicHttpUrl("HOMARR_WEBSITE_URL").default("https://homarr.dev"),
|
HOMARR_WEBSITE_URL: publicHttpUrl("HOMARR_WEBSITE_URL").default("https://homarr.dev"),
|
||||||
@@ -27,6 +28,7 @@ export const env = createEnv({
|
|||||||
},
|
},
|
||||||
runtimeEnv: {
|
runtimeEnv: {
|
||||||
KUBERNETES_SERVICE_ACCOUNT_NAME: process.env.KUBERNETES_SERVICE_ACCOUNT_NAME,
|
KUBERNETES_SERVICE_ACCOUNT_NAME: process.env.KUBERNETES_SERVICE_ACCOUNT_NAME,
|
||||||
|
UNSAFE_ENABLE_MOCK_INTEGRATION: process.env.UNSAFE_ENABLE_MOCK_INTEGRATION,
|
||||||
DEMO_MODE: process.env.DEMO_MODE,
|
DEMO_MODE: process.env.DEMO_MODE,
|
||||||
DEMO_READ_ONLY: process.env.DEMO_READ_ONLY,
|
DEMO_READ_ONLY: process.env.DEMO_READ_ONLY,
|
||||||
HOMARR_WEBSITE_URL: process.env.HOMARR_WEBSITE_URL,
|
HOMARR_WEBSITE_URL: process.env.HOMARR_WEBSITE_URL,
|
||||||
|
|||||||
@@ -18,7 +18,12 @@ import {
|
|||||||
integrationSecrets,
|
integrationSecrets,
|
||||||
integrationUserPermissions,
|
integrationUserPermissions,
|
||||||
} from "@homarr/db/schema";
|
} from "@homarr/db/schema";
|
||||||
import type { GroupPermissionKey, IntegrationPermission, IntegrationSecretKind } from "@homarr/definitions";
|
import type {
|
||||||
|
GroupPermissionKey,
|
||||||
|
IntegrationKind,
|
||||||
|
IntegrationPermission,
|
||||||
|
IntegrationSecretKind,
|
||||||
|
} from "@homarr/definitions";
|
||||||
import {
|
import {
|
||||||
getIntegrationKindsByCategory,
|
getIntegrationKindsByCategory,
|
||||||
getPermissionsWithParents,
|
getPermissionsWithParents,
|
||||||
@@ -39,6 +44,7 @@ import {
|
|||||||
} from "@homarr/validation/integration";
|
} from "@homarr/validation/integration";
|
||||||
import { mediaRequestOptionsSchema, mediaRequestRequestSchema } from "@homarr/validation/widgets/media-request";
|
import { mediaRequestOptionsSchema, mediaRequestRequestSchema } from "@homarr/validation/widgets/media-request";
|
||||||
|
|
||||||
|
import { env } from "../../env";
|
||||||
import { createOneIntegrationMiddleware } from "../../middlewares/integration";
|
import { createOneIntegrationMiddleware } from "../../middlewares/integration";
|
||||||
import { createTRPCRouter, permissionRequiredProcedure, protectedProcedure, publicProcedure } from "../../trpc";
|
import { createTRPCRouter, permissionRequiredProcedure, protectedProcedure, publicProcedure } from "../../trpc";
|
||||||
import { throwIfActionForbiddenAsync } from "./integration-access";
|
import { throwIfActionForbiddenAsync } from "./integration-access";
|
||||||
@@ -48,6 +54,15 @@ import { mapTestConnectionError } from "./map-test-connection-error";
|
|||||||
const logger = createLogger({ module: "integrationRouter" });
|
const logger = createLogger({ module: "integrationRouter" });
|
||||||
const mediaRequestSearchKinds = getIntegrationKindsByCategory("mediaSearch");
|
const mediaRequestSearchKinds = getIntegrationKindsByCategory("mediaSearch");
|
||||||
|
|
||||||
|
const throwIfMockIntegrationIsDisabled = (kind: IntegrationKind) => {
|
||||||
|
if (kind !== "mock" || env.UNSAFE_ENABLE_MOCK_INTEGRATION) return;
|
||||||
|
|
||||||
|
throw new TRPCError({
|
||||||
|
code: "FORBIDDEN",
|
||||||
|
message: "Mock integrations are disabled",
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
export const integrationRouter = createTRPCRouter({
|
export const integrationRouter = createTRPCRouter({
|
||||||
getKinds: publicProcedure
|
getKinds: publicProcedure
|
||||||
.meta({
|
.meta({
|
||||||
@@ -58,12 +73,14 @@ export const integrationRouter = createTRPCRouter({
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
.query(() => {
|
.query(() => {
|
||||||
return objectEntries(integrationDefs).map(([kind, def]) => ({
|
return objectEntries(integrationDefs)
|
||||||
kind,
|
.filter(([kind]) => kind !== "mock" || env.UNSAFE_ENABLE_MOCK_INTEGRATION)
|
||||||
name: def.name,
|
.map(([kind, def]) => ({
|
||||||
category: def.category,
|
kind,
|
||||||
requiredSecrets: def.secretKinds,
|
name: def.name,
|
||||||
}));
|
category: def.category,
|
||||||
|
requiredSecrets: def.secretKinds,
|
||||||
|
}));
|
||||||
}),
|
}),
|
||||||
all: protectedProcedure
|
all: protectedProcedure
|
||||||
.meta({
|
.meta({
|
||||||
@@ -229,6 +246,8 @@ export const integrationRouter = createTRPCRouter({
|
|||||||
})
|
})
|
||||||
.input(integrationCreateSchema)
|
.input(integrationCreateSchema)
|
||||||
.mutation(async ({ ctx, input }) => {
|
.mutation(async ({ ctx, input }) => {
|
||||||
|
throwIfMockIntegrationIsDisabled(input.kind);
|
||||||
|
|
||||||
logger.info("Creating integration", {
|
logger.info("Creating integration", {
|
||||||
name: input.name,
|
name: input.name,
|
||||||
kind: input.kind,
|
kind: input.kind,
|
||||||
|
|||||||
@@ -321,6 +321,13 @@ export const onboardRouter = createTRPCRouter({
|
|||||||
.requiresStep("setup")
|
.requiresStep("setup")
|
||||||
.input(onboardingCompleteSetupSchema)
|
.input(onboardingCompleteSetupSchema)
|
||||||
.mutation(async ({ ctx, input }) => {
|
.mutation(async ({ ctx, input }) => {
|
||||||
|
if (
|
||||||
|
!env.UNSAFE_ENABLE_MOCK_INTEGRATION &&
|
||||||
|
input.integrations.some((integration) => integration.kind === "mock")
|
||||||
|
) {
|
||||||
|
throw new TRPCError({ code: "FORBIDDEN", message: "Mock integrations are disabled" });
|
||||||
|
}
|
||||||
|
|
||||||
const boardList = await ctx.db.query.boards.findMany({
|
const boardList = await ctx.db.query.boards.findMany({
|
||||||
with: {
|
with: {
|
||||||
sections: { with: { layouts: true } },
|
sections: { with: { layouts: true } },
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
import { readFile, writeFile } from "fs/promises";
|
import { readFile, writeFile } from "fs/promises";
|
||||||
import {
|
import { integrationDefs } from "../packages/definitions/src/integration";
|
||||||
getIntegrationDocumentationUrl,
|
|
||||||
integrationDefs,
|
|
||||||
integrationKinds,
|
|
||||||
} from "../packages/definitions/src/integration";
|
|
||||||
|
|
||||||
const FILE = "docs/README.md";
|
const FILE = "docs/README.md";
|
||||||
const MAX_COLUMNS_PER_ROW = 7;
|
const MAX_COLUMNS_PER_ROW = 7;
|
||||||
@@ -25,29 +21,19 @@ async function updateIntegrationList() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Generate the new integration list
|
// Generate the new integration list
|
||||||
const integrations = integrationKinds
|
const integrations = Object.values(integrationDefs)
|
||||||
.filter((kind) => kind !== "mock")
|
.filter((def) => def.name !== "Mock")
|
||||||
.map((kind) => ({
|
.sort((a, b) => a.name.localeCompare(b.name));
|
||||||
...integrationDefs[kind],
|
|
||||||
documentationUrl: getIntegrationDocumentationUrl(kind),
|
|
||||||
}))
|
|
||||||
.toSorted((a, b) => a.name.localeCompare(b.name));
|
|
||||||
const tableRows: string[] = [];
|
const tableRows: string[] = [];
|
||||||
let currentRow: string[] = [];
|
let currentRow: string[] = [];
|
||||||
|
|
||||||
integrations.forEach((integration) => {
|
integrations.forEach((integration) => {
|
||||||
const cellBody = `
|
currentRow.push(`<td align="center">
|
||||||
|
<a href="${integration.documentationUrl}" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="${integration.iconUrl}" alt="${integration.name}" width="90" height="90" />
|
<img src="${integration.iconUrl}" alt="${integration.name}" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">${integration.name.replaceAll(" ", "<br/>")}</p>
|
<p align="center">${integration.name.replaceAll(" ", "<br/>")}</p>
|
||||||
`;
|
</a>
|
||||||
let cellContent = `<div>${cellBody}</div>`;
|
|
||||||
if (integration.documentationUrl !== null) {
|
|
||||||
cellContent = `<a href="${integration.documentationUrl}" target="_blank" rel="noreferrer noopener">${cellBody}</a>`;
|
|
||||||
}
|
|
||||||
|
|
||||||
currentRow.push(`<td align="center">
|
|
||||||
${cellContent}
|
|
||||||
</td>`);
|
</td>`);
|
||||||
|
|
||||||
if (currentRow.length === MAX_COLUMNS_PER_ROW) {
|
if (currentRow.length === MAX_COLUMNS_PER_ROW) {
|
||||||
@@ -81,7 +67,4 @@ ${endMarker}`;
|
|||||||
await writeFile(FILE, newContent, "utf8");
|
await writeFile(FILE, newContent, "utf8");
|
||||||
}
|
}
|
||||||
|
|
||||||
updateIntegrationList().catch((error: unknown) => {
|
updateIntegrationList().catch(console.error);
|
||||||
console.error(error);
|
|
||||||
process.exitCode = 1;
|
|
||||||
});
|
|
||||||
Reference in new issue
Block a user