https://github.com/iVictaTech/netlink-cloudflare-ddns

This package helps you to update your Dynamic WAN IP of Netlink Router into Cloudflare Dynamic DNS (DDNS) service.
https://github.com/iVictaTech/netlink-cloudflare-ddns

Last synced: about 2 months ago
JSON representation

This package helps you to update your Dynamic WAN IP of Netlink Router into Cloudflare Dynamic DNS (DDNS) service.

• Host: GitHub
• URL: https://github.com/iVictaTech/netlink-cloudflare-ddns
• Owner: iVictaTech
• License: mit
• Created: 2022-02-26T19:47:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-02-26T23:18:09.000Z (over 2 years ago)
• Last Synced: 2024-07-24T01:33:27.140Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 720 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Netlink Cloudflare DDNS

[![MIT License](https://img.shields.io/github/license/NVictaTechSolution/netlink-cloudflare-ddns)](https://raw.githubusercontent.com/NVictaTechSolution/netlink-cloudflare-ddns/main/LICENSE)

![Tag](https://img.shields.io/github/v/tag/NVictaTechSolution/netlink-cloudflare-ddns)

![Open Issues](https://img.shields.io/github/issues/NVictaTechSolution/netlink-cloudflare-ddns)

This package helps you to update your Dynamic WAN IP of Netlink Router into Cloudflare Dynamic DNS (DDNS) service.

You will be able to remotely access your home network with your custom domain registered in Cloudflare.

## Installation

Install **netlink-cloudflare-ddns** with **npm**

```bash

  npm install netlink-cloudflare-ddns

```

## API Reference

| Parameter         | Type             | Description                                                                |

| :---------------- | :--------------- | :------------------------------------------------------------------------- |

| `email`           | `string`         | The email used to login 'https://dash.cloudflare.com'                      |

| `auth_method`     | `global / token` | Set to "**global**" for Global API Key or "**token**" for Scoped API Token |

| `auth_key`        | `string`         | Your API Token or Global API Key                                           |

| `zone_identifier` | `string`         | Your **Zone Id**, Can be found in the "**Overview**" tab of your domain    |

| `record_name`     | `string`         | Name of **A record** you want to update                                    |

| `ttl`             | `string`         | Set the DNS TTL (seconds)                                                  |

| `proxy`           | `boolean`        | Set the proxy to true or false                                             |

| `gateWayIp`       | `string`         | The router gateway Ip address                                              |

| `username`        | `string`         | The user name of router                                                    |

| `password`        | `string`         | The password of router                                                     |

## Usage/Examples

```javascript

// ES6 or TypeScript:

import netlinkDDns from 'netlink-cloudflare-ddns';

// In other environments:

const netlinkDDns = require('netlink-cloudflare-ddns');

setInterval(async () => {

  await netlinkDDns({

    email: '[email protected]',

    auth_key: 'smlkSIOKMSJBJBCXJBmSKMSSOsMOm0OSK',

    auth_method: 'token',

    record_name: 'test.example.com',

    zone_identifier: '2dfsd2fs2dfsff1s2fs212sf1f2sf1fsfg',

    proxy: false,

    ttl: 3600,

    gateWayIp: '192.168.1.1',

    username: 'admin',

    password: 'admin',

  });

}, 10000);

```

## Reference

This project is referenced from [cloudflare-ddns-updater](https://github.com/K0p1-Git/cloudflare-ddns-updater)

## License

[MIT](https://raw.githubusercontent.com/NVictaTechSolution/netlink-cloudflare-ddns/main/LICENSE)