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

70 lines
3.5 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)
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
### Installation
* Copy all files to your webspace
* 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:
* `username` -> The username for your Router to authenticate (so not everyone can update your DNS)
* `password` -> password for your Router
* `apiKey` -> API key which is generated in netcup CCP
* `apiPassword` -> API password which is generated in netcup CCP
* `customerId` -> your netcup Customer ID
* `debug` -> true|false enables debug mode and generates output of update.php (normal operation has no output)
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 to be more precise Learning from #19
2022-02-14 14:24:35 +01:00
* Create each host record in your netcup CCP (DNS settings) before using the script. The script does not create any missing records.
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
* 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