Giter Club home page Giter Club logo

netlify-dynamic-dns's Introduction

Netlify Dynamic DNS

Go Report Card

A dynamic DNS client for Netlify's Managed DNS service. It is a simple command line tool that retrieves your public IP and sets it to a DNS record using the Netlify API.

Installation

Click Here to go to the Github Releases and download the correct installer for your platform. Alternatively, it can be run using Docker.

docker run oscartbeaumont/netlify-dynamic-dns:latest updater --access-token={Personal Access Token}

Usage

Netlify Dynamic DNS has two modes it can be used in. When calling the binary use the following format.

netlify-ddns [MODE] [FLAGS]

Update Mode

In update mode, the dynamic DNS will run once and then exit. This is good for use with a cron job or when you just want to manually update the DNS record.

netlify-ddns update --access-token={Personal Access Token}

Updater Mode

In updater mode, the dynamic DNS will automatically update on an interval. This will continue until the application is terminated. This is good for running in a daemon.

netlify-ddns updater --access-token={Personal Access Token}

Flags

Flag Default Description
access-token The personal access tokens for your Netlify accounts. Can be created in 'User Settings > Applications' on the dashboard.
domain example.com The full domain for the DNS record
subdomain home The subdomain segment for the DNS record.
ipv6 true Whether the IPv6 'AAAA' DNS record should be updated.
interval 5 The interval (in minutes) to update your DNS record in the updater mode.

Netlify Access Token

To use this application you must first get an access token from Netlify. This allows the application to talk to the Netlify API on behalf of your account. To do that please go to the Netlify OAuth applications page and create a new Personal access token.

How It Works

Netlify Dynamic DNS uses ident.me to determine the public IPv4 and IPv6 of the server and then talks to the Netlify API to create an A and AAAA record for those addresses. If duplicate DNS entries are detected they will be removed.

Contributing

To work on the codebase, use the following commands.

git clone https://github.com/oscartbeaumont/netlify-dynamic-dns.git
go run ./cmd

netlify-dynamic-dns's People

Contributors

oscartbeaumont avatar andela-oakinniranye avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.