Code Monkey home page Code Monkey logo

serverless-ddns's Introduction

serverless-ddns

serverless

Prerequisites

Make sure you have the following installed before starting:

Installation

git clone https://github.com/jmb12686/serverless-ddns
cd serverless-ddns
npm install

Configuration

Modify the following configuration parameters in config.json:

apiDomainName - URL to host on API Gateway. Must have matching AWS Certificate Manager and own domain in Route53

ddnsHostName - Domain name, owned in Route 53, that you want to keep updated with a dynamic IP.

notificationTopicARN - TopicARN, in SNS, that you wish to receive notifications on. Notifications are sent upon a successful DDNS update or failed attempt.

Deployment

First, create the custom domain in API Gateway and route53 (corresponds to the apiDomainName config variable):

serverless create_domain

Now, deploy the serverless stack:

serverless deploy

NOTE: Use --stage prod to deploy to prod

Usage

Usage instructions for interacting with the ddns API

Fetch caller IP

Fetch current caller IP, similar to 'what's my ip':

$ curl https://apiDomainName

Update DNS with new IP

POST 'homeIp' JSON to API endpoint with AWS IAM Signature. User api user is created upon stack deployment. Use aws-authenticated-curl-utility to properly sign authenticated requests

$ post_it.sh -credentials <aws_access_key>:<aws_secret_key> -url <api_url> -region us-east-1 -service execute-api -body "'{\"homeIp\":\"$ip\"}'"

TODO

  1. Eliminate topicARN requirement, and instead send to arbitrary email and/or SMS

serverless-ddns's People

Contributors

dependabot-preview[bot] avatar jmb12686 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  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.