sujiba/ownDynDNS
1
0
Fork 0
mirror of https://github.com/fernwerker/ownDynDNS.git synced 2025-07-11 22:45:43 +02:00
Code Issues Releases Activity Actions
ownDynDNS/README.md

136 lines
7.4 KiB
Markdown
Raw Normal View History

modified: README.md layout and meta infos
2018-08-06 21:20:14 +02:00
# ownDynDNS
* rewrite the hole script: ** use .env file for config so we can retrieve updates ** add config and payload DTO with validators ** allow registrable domains as DynDNS ** update IPv4/6 only if changed (or really forced) ** remove obsolete failed_logins counter ** save logs with timestamp ** save only the newest 100 log entries for each domain
2019-05-16 18:00:21 +02:00
Self-hosted dynamic DNS php script to update netcup DNS API from Router like AVM FRITZ!Box
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
## Authors
modified: README.md
2018-08-06 21:25:47 +02:00
* Felix Kretschmer [@fernwerker](https://github.com/fernwerker)
* Philipp Tempel [@philipptempel](https://github.com/philipptempel)
* rewrite the hole script: ** use .env file for config so we can retrieve updates ** add config and payload DTO with validators ** allow registrable domains as DynDNS ** update IPv4/6 only if changed (or really forced) ** remove obsolete failed_logins counter ** save logs with timestamp ** save only the newest 100 log entries for each domain
2019-05-16 18:00:21 +02:00
* Branko Wilhelm [@b2un0](https://github.com/b2un0)
added some info
2023-08-22 14:53:42 +02:00
* Nils Blume [@niiwiicamo](https://github.com/niiwiicamo)
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
## Usage
Update to include configure scripts
2023-08-24 16:02:17 +02:00
### Install using configure scripts
* Copy `update.php`, `src/*`, `.env.dist`, `.configure.sh` and `.configure-endpoints.sh` to your webspace
* If you want multiple endpoints use .configure-endpoints.sh
* If you want a single endpoint use .configure.sh
### Manual Installation
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
* Copy all files to your webspace
added multi-endpoint description
2023-08-23 23:51:32 +02:00
* If you want multiple endpoints that each can only update one domain look at the mydomain folder.<br>
The update URL would be https://`url`/mydomain/update.php?(...)
* rewrite the hole script: ** use .env file for config so we can retrieve updates ** add config and payload DTO with validators ** allow registrable domains as DynDNS ** update IPv4/6 only if changed (or really forced) ** remove obsolete failed_logins counter ** save logs with timestamp ** save only the newest 100 log entries for each domain
2019-05-16 18:00:21 +02:00
* create a copy of `.env.dist` as `.env` and configure:
added domain restriction capability
2023-08-23 23:47:23 +02:00
Parameter | Example | Explanation
---: | :--- | :---
`username` | dnsupdater | The username for your Router to authenticate (so not everyone can update your DNS)
`password` | secretpleasechange | password for your Router
`apiKey` | 18neqwd91e21onei1p23841 | API key which is generated in netcup CCP
`apiPassword` | 82jewqde9m30 | API password which is generated in netcup CCP
`customerId` | 12345 | your netcup Customer ID
`log` | `true` / false | enables logging
`logFile` | log.json | configures logfile location if enabled
`debug` | true / `false` | enables debug mode and generates more output from update.php (normal operation has no output). Needed to receive stack traces from errors.
`returnIp` | `true` / false | enables return of result if a record was changed
`allowCreate` | true/`false` | allows creation of entries if parameter `create=true` in URL
`restrictDomain` | true / `false` | allows admin to restrict the domain to update to a given value `domain` and/or `host`. See URL parameters for host parameter explanation
added some info
2023-08-22 14:53:42 +02:00
* alternatively you can use .configure.sh to create your .env file for you (if you are on a *NIX system)
added domain restriction capability
2023-08-23 23:47:23 +02:00
* Create each host record in your netcup CCP (DNS settings) before using the script. <s>The script does not create any missing records.</s><br>
You can now set `allowCreate=true` in .env and pass `create=true` as URL parameter to create entries on the fly.
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
updated readme for new features
2023-08-22 22:46:56 +02:00
## URL possible uses:
### Required parameters in URL:
<b>user, password and domain</b> are <i> always needed</i>, as well as at least one of the following: <br>
<b>ipv4, ipv6, txt</b>
Parameter | Example | Explanation
---: | :--- | :---
user | dnsupdater | username to authenticate against this script as defined in .env file
password | secretpleasechange |password for that user as defined in .env file
domain | home.example.com | `case A)` If `host` is not specified: the FQDN for your host
domain | example.com | `case B)` If you want to update the @ or * record
domain | example.com | `case C)` If `host`is specified: only the domain part as registered at netcup "nas.home.example.com"
host | nas.home | `case C)` If your domain contains more than 3 levels "nas.home.example.com"
ipv4 | 1.2.3.4 | the ipv4 address to update an existing A record
ipv6 | fe80::12:34:56 | the ipv6 address to update an existing AAAA record
txt | acme-challenge-text | the content to update an existing TXT record
force | true | ignore checking if the record needs to be updated, just do it anyways. Default: `false`
mode | * | `case B)` If domain is your registered domain "example.com". Possible values: `*` or `both`. Default: `@`
include create
2023-08-23 13:14:56 +02:00
create | true | create all entries if none exist. e.g. will not create A if AAAA exists. Needs `allowCreate=true` in .env
updated readme for new features
2023-08-22 22:46:56 +02:00
#### Example URL to update A record (IPv4) of home.example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`home.example.com`&ipv4=`IPv4`
#### Example URL to force update AAAA record (IPv6) of example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`example.com`&ipv6=`IPv6`&force=`true`
#### Example URL to update A and AAAA records of home.example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`home.example.com`&ipv4=`IPv4`&ipv6=`IPv6`
#### Example URL to update TXT record _acme-challenge of home.example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`_acme-challenge.example.com`&txt=`textcontent`
#### Example URL to update A record of nas.home.example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`example.com`&host=`nas.home`&ipv4=`IPv4`
#### Example URL to update AAAA wildcard record of example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`example.com`&mode=`*`
include create
2023-08-23 13:14:56 +02:00
#### Example URL to create A and TXT records of new.example.com:
https://`dyndns.example.com`/update.php?user=`username`&password=`password`&domain=`new.example.com`&ipv4=`IPv4`&txt=`textcontent`&create=`true`
updated readme for new features
2023-08-22 22:46:56 +02:00
* rewrite the hole script: ** use .env file for config so we can retrieve updates ** add config and payload DTO with validators ** allow registrable domains as DynDNS ** update IPv4/6 only if changed (or really forced) ** remove obsolete failed_logins counter ** save logs with timestamp ** save only the newest 100 log entries for each domain
2019-05-16 18:00:21 +02:00
### AVM FRITZ!Box Settings
* Go to "Internet" -> "Freigaben" -> "DynDNS"
* Choose "Benutzerdefiniert"
Update README.md Fixed the Readme, to be compatible with the FRITZ!Box Settings
2023-05-12 21:23:34 +02:00
* Update-URL: `https://<url of your webspace>/update.php?user=<username>&password=<pass>&ipv4=<ipaddr>&ipv6=<ip6addr>&domain=<domain>`
* only the url needs to be adjusted, the rest is automatically filled by your AVM FRITZ!Box
* http or https is possible if valid SSL certificate (e.g. Let's Encrypt)
Update README.md Added description how to update multiple domains
2023-05-12 21:10:01 +02:00
* Single Domain:
Update README.md Fixed the Readme, to be compatible with the FRITZ!Box Settings
2023-05-12 21:23:34 +02:00
* Domainname: `<host record that is supposed to be updated>`
* Multiple Domains:
* Domainname: `<first host record that is supposed to be updated>,<second host record that is supposed to be updated>,....`
minimum improvements on major refoctoring of b2un0: - updated README.md to new filenames - added log.json creation if not existent in Handler.php
2019-05-16 23:22:13 +02:00
* Username: `<username as defined in .env file>`
* Password: `<password as definied in .env file>`
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
Update README.md Added Synology and pfSense configurations
2023-08-11 10:15:25 +02:00
### Synology DSM Settings
* Go to "Control Panel" -> "External Access" -> "DDNS"
* Click on "Customize Provider" to create a profile for your own DDNS server
* Service Provider: This is the display name of your custom provider
* Update-URL: `https://<url of your webspace>/update.php?user=__USERNAME__&password=__PASSWORD__&ipv4=__MYIP__&domain=__HOSTNAME__`
* Attention: The variables are delimited by two underscores
* Currently Synology custom DDNS does not support IPv6, for whatever reason.
* Save your custom provider
* Click on "Add" to create a DDNS job
* Select your custom provider. Notice that an asterisk [*] has appeared in front of the name to signify that this is a custom provider.
* Hostname: `<host record that is supposed to be updated>`
* Username/Email: `<username as defined in .env file>`
* Password/Key: `<password as defined in .env file>`
* External Address (IPv4): probably "Auto", uses Synology service to find own external IP
* External Address (IPv6): doesn't matter, currently not supported by Synology
### pfSense Settings
* Go to "Services" -> "Dynamic DNS"
* Click on "Add" to create a DDNS profile
* Service Type: "Custom"
* Interface to monitor: `<select you WAN interface>`
* Interface to send update from: `<select your WAN interface>`
* Update URL: `https://<url of your webspace>/update.php?user=<user from .env>&password=<password from .env>&ipv4=%IP%&domain=<host record to update>`
* Leave all other fields empty / default
* rewrite the hole script: ** use .env file for config so we can retrieve updates ** add config and payload DTO with validators ** allow registrable domains as DynDNS ** update IPv4/6 only if changed (or really forced) ** remove obsolete failed_logins counter ** save logs with timestamp ** save only the newest 100 log entries for each domain
2019-05-16 18:00:21 +02:00
# run as cronjob on a **nix based device
* see [examples](./examples)
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
## References
* DNS API Documentation: https://ccp.netcup.net/run/webservice/servers/endpoint.php
modified: README.md added link to dnsapi.php by netcup
2018-08-06 21:15:16 +02:00
* Source of dnsapi.php: https://ccp.netcup.net/run/webservice/servers/endpoint.php?PHPSOAPCLIENT
modified: README.md new file: dnsapi.php new file: update.php initial commit with working update.php and dnsapi.php by netcup
2018-08-06 21:13:49 +02:00
## License
Published under GNU General Public License v3.0
updated on copyright year, and ping to see project is active but nothing to do currently
2021-03-16 10:44:41 +01:00
&copy; Felix Kretschmer, 2021
Reference in a new issue Copy permalink