Skip to content

Commit

Permalink
Added a license and small fixes in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
fleaz committed Mar 7, 2022
1 parent deb0a5a commit bbdd5c6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) Felix Breidenstein

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.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A DIY DynDNS service build upon AWS Route53
This tool will try to determine the current external IPv4 and IPv6 address of
the host and then update an entry in a domain at Route53. To do this you
obivously need a domain hosted at R53. If you already have a domain somewhere
else you can e.g. create a seperate subdomain like `dyn.fleaz.me` which gets
else you can e.g. create a seperate subdomain like `dyn.yourdomain.com` which gets
delegated to R53 so you don't have to change anything in your current DNS setup
or migrate the domain.

Expand All @@ -15,8 +15,8 @@ the hosted domain in R53 plus $0.4 per 1M requests. So you will pretty surely
never exceed $1 even after adding tax.

**WARNING**: Pushing just one wrong button in the AWS Console can cost you a lot
*of money. So if you play around with cloud stuff, always configure a "Billing
*alarm" so you wont be surprised at the end of the month with a big bill :)
of money. So if you play around with cloud stuff, always configure a "Billing
alarm" so you wont be surprised at the end of the month with a big bill :)

# IAM Permissions
You need to create an IAM user which has the permission to update records on the
Expand All @@ -36,15 +36,16 @@ domain you want to use for DynDNS which should look like this:
}
```

Because this gives access to the complete zone, using a seperate subdomain like desribed in the setup section is a good idea.
Because this gives access to the complete zone, using a seperate subdomain like
desribed in the setup section is a good idea.

# Running this tool
Put the AWS keys you just created in the `~/.aws/credentials` file of the user
which will run this tool and then create a cronjob looking like this which will
call the tool every 15 minutes:
```
*/15 * * * * /usr/local/bin/r53-ddns -zone-id <ZONE_ID> -domain dyn.fleaz.me
*/15 * * * * /usr/local/bin/r53-ddns -zone-id <ZONE_ID> -domain <DOMAIN_NAME>
```

Either wait until the first run or start the tool manually once and check the
R53 dashboard for your newly generated AAAA and A records.
R53 dashboard for your newly generated AAAA and A records.

0 comments on commit bbdd5c6

Please sign in to comment.