alessioalex / dynroute Goto Github PK

  __                                        __
 /\ \                                      /\ \__
 \_\ \  __  __    ___   _ __   ___   __  __\ \ ,_\    __
 /'_` \/\ \/\ \ /' _ `\/\`'__\/ __`\/\ \/\ \\ \ \/  /'__`\
/\ \L\ \ \ \_\ \/\ \/\ \ \ \//\ \L\ \ \ \_\ \\ \ \_/\  __/
\ \___,_\/`____ \ \_\ \_\ \_\\ \____/\ \____/ \ \__\ \____\
 \/__,_ /`/___/> \/_/\/_/\/_/ \/___/  \/___/   \/__/\/____/
            /\___/
            \/__/

Node.js command line tool for dynamically updating your domain's dns to your current ip using Amazon Route53.

dynroute -h

Usage: dynroute [options]

Options:
   -d, --domain          Domain(s) to update [required] (you can specify multiple domains, ex: -d ro.domain.com -d en.domain.com)
   -z, --zone            Route 53 Zone ID that the domain lives in [default: searches all zones for domain]
   -ttl, --ttl           Time To Leave (in seconds) [default: 60]
   -t, --time            How frequently to check for IP update [default: 60]
   -o, --once            Check for IP update ONLY ONCE and exit [default: false]
   -g, --growl           Display growl notification after IP update [default: false]
   -aws, --awskeys       The path for the config file containing AWS credentials [default ~/.awsrc]
   -ipserv, --ipserver   Resp: { ip: "YOUR_IP_HERE" } [default https://api.ipify.org?format=json]
   -dbg, --debug         Print debugging info
   -v, --version         Print version and exit

$ npm install -g dynroute

• Create a hosted zone for your domain in Route53, in case you don't already have one.
• Update your domain's nameservers with the ones provided by Route53 (for that hosted zone).
• Put your credentials into a config file such as ~/.awsrc (used by default)

[credentials]
accessKeyId     = AAAAAAAAAAAAAAAAAAAA
secretAccessKey = bbbbbbbbbbbbbbbbbbbbbLwccccembeMdddddI4e

Note that you might want to create another AWS user has CRUD rights for Route53 and use that instead of the admin account. Here's a sample AWS user policy:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "route53:ListHostedZones",
                "route53:ListResourceRecordSets",
                "route53:ChangeResourceRecordSets",
                "route53:CreateHostedZone",
                "route53domains:*"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

dynroute -d home.mydomain.com --once

dynroute -d home.mydomain.com

By default the script will check every 60 seconds if your ip updated, but you can customize that:

dynroute -d home.mydomain.com --time 120

You can setup Growl notifications to let you know when your IP has been updated for your domain.

Ex:

dynroute -d localhost.mydomain.com --growl

If there is no A record for that hosted zone that matches your request the script will automatically create one.

• Alexandru Vladutu
• Jon Hazan (https://github.com/hazanjon)

(The MIT License)

Copyright (c) 2012 Alexandru Vlăduţu <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.