Skip to content

Getting Started

This section covers everything you need to get external-dns-unifios-webhook up and running.

  • Prerequisites

    System requirements and UniFi controller preparation.

    Prerequisites

  • Installation

    Deploy the webhook with Helm or manually.

    Installation

  • Quick Start

    Get DNS records syncing in 5 minutes.

    Quick Start

Overview

The external-dns-unifios-webhook acts as a bridge between external-dns and your UniFi controller's DNS management. When you create Kubernetes resources with DNS annotations, external-dns detects them and sends DNS record operations to this webhook, which then manages the records in your UniFi controller.

flowchart LR
    K8s[Kubernetes Resources] --> ED[external-dns]
    ED --> WH[UniFi Webhook]
    WH --> UC[UniFi Controller]
    UC --> DNS[DNS Records]

Next Steps

  1. Review the Prerequisites to ensure your environment is ready
  2. Follow the Installation guide to deploy the webhook
  3. Complete the Quick Start to verify everything works