a2bb53a8b8
Co-authored-by: Lokesh-Kumar-Dudi <lkumardudi@gmail.com> Co-authored-by: Thomas Camlong <thomas@ajnart.fr>
53 lines
1.5 KiB
Plaintext
53 lines
1.5 KiB
Plaintext
---
|
|
title: 'Gluetun'
|
|
description: 'Connect Gluetun to Homarr as a VPN integration.'
|
|
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 { gluetunIntegration } from '.';
|
|
import { vpnWidget } from '@site/docs/widgets/vpn';
|
|
|
|
<IntegrationHeader
|
|
integration={gluetunIntegration}
|
|
categories={['VPN', 'Network']}
|
|
/>
|
|
|
|
[Gluetun](https://github.com/qdm12/gluetun) exposes a control server that Homarr can query to report the VPN tunnel
|
|
status, DNS status, public IP address, and active provider details in the VPN widget.
|
|
|
|
### Widgets & Capabilities
|
|
|
|
<IntegrationCapabilites
|
|
items={[{
|
|
widget: vpnWidget,
|
|
}]}
|
|
/>
|
|
|
|
### Setting up the Gluetun control server
|
|
|
|
Refer to the [Gluetun control server documentation](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md#authentication) to enable and configure authentication.
|
|
|
|
### Adding the integration
|
|
|
|
<AddingIntegration />
|
|
|
|
### Secrets
|
|
|
|
Gluetun's control server can be left unprotected or secured with either an API key or HTTP Basic authentication.
|
|
Choose the option that matches how your Gluetun instance integration is set up.
|
|
|
|
<IntegrationSecrets secrets={[{
|
|
credentials: [],
|
|
steps: [],
|
|
},{
|
|
credentials: ['username', 'password'],
|
|
steps: [],
|
|
},{
|
|
credentials: ['apiKey'],
|
|
steps: [],
|
|
},,]} />
|