Newtbot/cloudflare-dns

CloudFlare DNS Updater

This project is designed to update a CloudFlare DNS record with your current public IP address if it changes. The script checks your public IP address and compares it with the IP address currently set in the DNS record. If the IPs are different, it updates the DNS record with the new IP.

Table of Contents

• Installation
• Usage
• Configuration
• Contributing
• License

Installation

Prerequisites

• Node.js (v14 or later)
• npm

Steps

1. Clone the repository:

   git clone https://github.com/your-username/cloudflare-dns-updater.git
   cd cloudflare-dns-updater

2. Install the dependencies:

   npm install

Usage

1. Create a .env file in the root of your project directory and add your CloudFlare API credentials and other required information:

   API_TOKEN=your_cloudflare_api_token
   ZONE_ID=your_cloudflare_zone_id
   DNS_RECORD_ID=your_dns_record_id
   BASE_URL=https://api.cloudflare.com/client/v4/zones/

2. Run the script:

   node your-script-file.js

Configuration

Environment Variables

• API_TOKEN: Your CloudFlare API token.
• ZONE_ID: The Zone ID of your CloudFlare domain.
• DNS_RECORD_ID: The DNS record ID you want to update.
• BASE_URL: Base URL for CloudFlare API (usually https://api.cloudflare.com/client/v4/zones/).

Script Flow

1. The script fetches your current public IP using the wtfismyip API.
2. It retrieves the current IP address set in the specified DNS record from CloudFlare.
3. If the IP addresses do not match, it updates the DNS record with the new public IP.

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -am 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Create a new Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.