54 lines
1.7 KiB
Plaintext
54 lines
1.7 KiB
Plaintext
---
|
|
title: "Coolify"
|
|
description: "Self-hosted PaaS and deployment platform"
|
|
hide_title: true
|
|
---
|
|
|
|
import { IntegrationHeader } from "@site/src/components/integrations/header";
|
|
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
|
|
import { AddingIntegration } from "@site/src/components/integrations/adding";
|
|
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
|
|
import { coolifyIntegration } from ".";
|
|
import { coolifyWidget } from "../../widgets/coolify";
|
|
|
|
<IntegrationHeader integration={coolifyIntegration} categories={["System monitoring", "Deployment"]} />
|
|
|
|
### Widgets & Capabilities
|
|
|
|
<IntegrationCapabilites items={[{ widget: coolifyWidget }]} />
|
|
|
|
### Adding the integration
|
|
|
|
<AddingIntegration />
|
|
|
|
:::info URL configuration
|
|
Use the root URL of your Coolify instance, for example `https://coolify.example.com`. Homarr calls Coolify endpoints under `/api` and `/api/v1` automatically.
|
|
:::
|
|
|
|
### Secrets
|
|
|
|
<IntegrationSecrets
|
|
secrets={[
|
|
{
|
|
credentials: ["apiKey"],
|
|
steps: [
|
|
"Open your Coolify instance and make sure you are in the team you want Homarr to monitor.",
|
|
<span>
|
|
Enable API access under <strong>Settings > Advanced</strong> if it is disabled.
|
|
</span>,
|
|
<span>
|
|
Go to <strong>Security > API Tokens</strong>.
|
|
</span>,
|
|
'Enter a name, e.g. "Homarr".',
|
|
<span>
|
|
Select the <code>read</code> permission. The Coolify widget only reads version, server, project, application,
|
|
and service data.
|
|
</span>,
|
|
'Click "Create".',
|
|
"Copy the generated token immediately. Coolify only shows it once.",
|
|
"Paste the token into the API Key field in Homarr.",
|
|
],
|
|
},
|
|
]}
|
|
/>
|