{"id":16854510,"url":"https://github.com/davispuh/dnsupdater","last_synced_at":"2025-03-22T06:31:03.401Z","repository":{"id":36931811,"uuid":"231289517","full_name":"davispuh/DNSUpdater","owner":"davispuh","description":"Update DNS records on local or remote (over SSH or HTTP) DNS server (eg. PowerDNS).","archived":false,"fork":false,"pushed_at":"2024-07-02T13:50:31.000Z","size":64,"stargazers_count":6,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T11:09:41.597Z","etag":null,"topics":["ddns","dns","http","powerdns","ssh"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davispuh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-02T01:59:52.000Z","updated_at":"2024-07-02T13:50:26.000Z","dependencies_parsed_at":"2024-10-28T17:45:55.869Z","dependency_job_id":null,"html_url":"https://github.com/davispuh/DNSUpdater","commit_stats":{"total_commits":19,"total_committers":2,"mean_commits":9.5,"dds":0.368421052631579,"last_synced_commit":"c69c268b83147a3f311304c24eb9e754f096c348"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davispuh%2FDNSUpdater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davispuh%2FDNSUpdater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davispuh%2FDNSUpdater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davispuh%2FDNSUpdater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davispuh","download_url":"https://codeload.github.com/davispuh/DNSUpdater/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244189625,"owners_count":20412986,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ddns","dns","http","powerdns","ssh"],"created_at":"2024-10-13T13:55:44.002Z","updated_at":"2025-03-22T06:31:02.905Z","avatar_url":"https://github.com/davispuh.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DNSUpdater - Dynamic DNS (DDNS)\n\nUsing this application you can update DNS records on local or remote (over SSH or HTTP) DNS server (eg. PowerDNS).\n\nFor example if you have dynamic IP you can use this application to automatically update DNS record with your external IP.\n\n## Installation\n\nFirst you need to have Ruby and RubyGems.\nThen you can install it with:\n\n```sh\n$ gem install DNSUpdater\n```\n\n### Install Systemd service files\n\n```sh\n$ cp service/dnsupdater.{service,timer} /etc/systemd/system/\n$ systemctl enable dnsupdater.timer\n```\n\nNote that you'll need to edit `/etc/systemd/system/dnsupdater.service` to set target domain.\n\n### Configure\n\nCreate `/etc/dnsupdater.yaml` with your settings, take a look at [config_example.yaml](config_example.yaml).\n\nBy default configuration file will be looked into current directory as `config.yaml` or in `/etc/dnsupdater.yaml`.\nBut you can specify any config path with `-c` flag.\n\n## Usage\n\n```sh\n$ updateDNS -h\nUsage: updateDNS [options] \u003ctarget\u003e\n    -c, --config config.yaml         Path to config file\n    -t, --target=PROTOCOL            Target protocol (useful for SSH)\n    -s, --serve                      Serve/handle HTTP\n    -h, --help                       Show this message\n\nSupported targets are: http, https, powerdns, ssh\nTarget examples:\n* default:///example.com/10.0.0.1\n* ssh://dns.example.com:123/example.org/client\n* http://example.org/dns.example.com/127.0.0.1,192.168.1.1\n```\n\n### Update DNS record on locally installed PowerDNS\n\n`$ updateDNS powerdns:///domain.example.com/192.168.1.1`\n\nNote that you'll need to set PowerDNS HTTP API key in config.\n\n### Update DNS record on remote PowerDNS over SSH with current external IP\n\n`$ updateDNS ssh://ssh.example.org/domain.example.com/client`\n\n`client` as IP means that DNS record will be updated with your external IP (client IP from target DNS server point).\n\nSSH settings can also be configured in `~/.ssh/config` which will be respected.\n\n### HTTP server mode\n\nDNSUpdater can also work as HTTP server and update DNS records from clients.\n\n`$ updateDNS --serve http://192.168.1.2/`\n\nFor authentication you'll need to set `SharedSecret` in config.\nAlso I recommend placing it behind Nginx.\n\nThen clients can do\n```\n$ updateDNS http://192.168.1.2/domain.example.com/client\n```\n\nPS. It also accepts DynDNS format: `/nic/update?hostname=yourhostname\u0026myip=ipaddress`\n\n### Update DNS record on firewalled remote PowerDNS over SSH with HTTP\n\nSuppose you have 3 machines:\n\n`A` - internal firewalled PowerDNS server which isn't accessible publicly.\n\n`B` - publicly accessible HTTP server.\n\n`C` - client who's external IP you want to set.\n\n\nOn `B` you would run `updateDNS -s` in HTTP server mode configured that it updates PowerDNS on `A` over SSH.\n\nOn `C` you would run `updateDNS https://B/mydomain.example.com/client`\n\n## Updaters/Providers\n\nBasically currently there's support only for PowerDNS and don't have BIND support,\nbut it should be pretty easy to add support for others so just send a PR :)\n\n## Documentation\n\nYARD with markdown is used for documentation (`redcarpet` required)\n\n## Specs\n\nRSpec and simplecov are required, to run tests just `rake spec`\ncode coverage will also be generated\n\n## Code status\n[![Gem Version](https://badge.fury.io/rb/DNSUpdater.png)](http://badge.fury.io/rb/DNSUpdater)\n[![Build Status](https://travis-ci.org/davispuh/DNSUpdater.png?branch=master)](https://travis-ci.org/davispuh/DNSUpdater)\n[![Coverage Status](https://coveralls.io/repos/davispuh/DNSUpdater/badge.png?branch=master)](https://coveralls.io/r/davispuh/DNSUpdater?branch=master)\n\n## Unlicense\n\n![Copyright-Free](http://unlicense.org/pd-icon.png)\n\nAll text, documentation, code and files in this repository are in public domain (including this text, README).\nIt means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.\n\n[About Unlicense](http://unlicense.org/)\n\n## Contributing\n\nFeel free to improve as you see.\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Export `.yaml` data files to binary `.dat` with `rake export`\n4. Commit your changes (`git commit -am 'Add some feature'`)\n5. Push to the branch (`git push origin my-new-feature`)\n6. Create new Pull Request\n\n\n**Warning**: By sending pull request to this repository you dedicate any and all copyright interest in pull request (code files and all other) to the public domain. (files will be in public domain even if pull request doesn't get merged)\n\nAlso before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.\n\nIf you don't want to dedicate code to public domain or if you're not allowed to (eg. you don't own required copyrights) then DON'T send pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavispuh%2Fdnsupdater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavispuh%2Fdnsupdater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavispuh%2Fdnsupdater/lists"}