pholawat-tle/name.com-ddns

A dynamic domain name server using Name.com API and Node.js hosted on Raspberry Pi

Node.js DDNS

A Node.js application that acts as a Dynamic Domain Name Server

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Usage
3. To-Do List
4. License

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/pholawat-tle/name.com-ddns

2. Install NPM packages

   npm install

Usage

1. In the application folder, copy the .env.example file and create a file called .env

   cp .env.example .env

2. Open .env with a text editor of your choice and correct the environment variables

   domainName=<--YOUR DOMAIN NAME-->
   namedotcom_username=<--YOUR NAME.COM USERNAME-->
   namedotcom_apiToken=<--YOUR NAME.COM API TOKEN-->
   

3. Start the application with npm

   npm run start

   or with Docker

   docker-compose up

To-Do List

• Set up a cron job
• Retrieve Public IP function
• Update Name.com API when Public IP change

License

Distributed under the MIT License. See LICENSE for more information.