syncflaer

SyncFlaer

Synchronize Traefik host rules with Cloudflare®.

Why?

• Dynamically create, update or delete Cloudflare® DNS records based on Traefik http rules
• Update DNS records when public IP changes
• Supports configuring additional DNS records that are not in Traefik

Contents

• SyncFlaer
  • Why?
  • Contents
  • Usage
    • Simple
    • Kubernetes
  • Configuration
    • Overview
      • Minimal Config File
      • Full Config File
      • Environment Variables
      • Defaults
    • Additional Records
      • A Record
      • CNAME Record
  • Copyright
  • License

Usage

Simple

Create a config file based on the example examples/config.yml located in this repository.

syncflaer -config-path /opt/syncflaer.yml

Flags:

  -config-path string
    	Path to config file (default "config.yml")
  -debug
    	Enable debug mode

Kubernetes

SyncFlaer can also run as a Kubernetes CronJob. Please refer to the examples/deploy directory of this repository.

Configuration

Overview

SyncFlaer is configurable via a YAML config file as well as some environment variables.

Minimal Config File

---
rootDomain: example.com

traefik:
  url: https://traefik.example.com

cloudflare:
  email: mail@example.com
  apiKey: abc

Full Config File

---
rootDomain: example.com

ipProviders:
  - https://ifconfig.me/ip
  - https://ipecho.net/plain
  - https://myip.is/ip

notifications:
  slack:
    webhookURL: https://hooks.slack.com/services/abc/def
    username: SyncFlaer
    channel: "#syncflaer"
    iconURL: https://url.to/image.png

traefik:
  url: https://traefik.example.com
  username: admin
  password: supersecure
  ignoredRules:
    - local.example.com
    - dev.example.com

additionalRecords:
  - name: vpn.example.com
    ttl: 120
  - name: a.example.com
    proxied: true
    type: A
    contents: 1.1.1.1

cloudflare:
  email: mail@example.com
  apiKey: abc
  defaults:
    type: CNAME
    proxied: true
    ttl: 1

Environment Variables

Note: Environment variables have a higher precedence than the config file!

The following environment variables are configurable:

Defaults

If not specified, the following config applies:

Additional Records

You can specify additional DNS records that are not configured as a Traefik host.

A Record

CNAME Record

Copyright

2021 Containeroo

Cloudflare and the Cloudflare Logo are registred trademarks owned by Cloudflare Inc. This project is not affiliated with Cloudflare®.

License

GNU GPLv3