Infendro/ddns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Activity

update README

Browse Source
This commit is contained in:
Infendro
2025-12-14 23:10:52 +01:00
parent 4a8244466e
commit 90b8f3f08a
1 changed files with 9 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,50 +1,39 @@
# DDNS # DDNS
This application enables automatically updating DNS records for various providers. DDNS is an application that enables the automatic updating of DNS records for various providers.
## Features Supported providers:
- Porkbun
* Automatically detect the current IP.
* Both IPv4 and IPv6 are supported.
* IP resolution depends on the selected service.
* ipify (default)
* Update DNS records in the selected provider.
* Porkbun
* Native (Linux)
## Build ## Build
Execute `./gradlew assemble`. Execute `./gradlew assemble`.
The resulting binary will be located in `./build/bin/releaseExecutable/`. The resulting binary will be located in `./build/bin/releaseExecutable/`.
Removing the extension from the binary and adding it to `/usr/local/bin/` enables the use of `ddns` in the terminal.
## Usage ## Usage
The following command updates all A and AAAA DNS records in Porkbun for `example.com` and `test.example.com`. The following command updates all A and AAAA DNS records in Porkbun for `example.com` and `test.example.com`.
``` ```
ddns porkbun \ ddns porkbun \
--key=... \ --key=<key> \
--secret-key=... \ --secret-key=<secret key> \
--domain=example.com \ --domain=example.com \
--subdomain= \ --subdomain= \
--subdomain=test --subdomain=test
``` ```
Optionally, a file can be used to declare one or more configurations. Alternatively, a file can be used to declare one or more configurations.
The above example can be declared as follows. The above example can be declared as follows.
``` ```
porkbun porkbun
key=... key=<key>
secret-key=... secret-key=<secret key>
domain=example.com domain=example.com
subdomain= subdomain=
subdomain=test subdomain=test
``` ```
To use this config file, execute the command `ddns --config=...`. To use this config file, execute the command `ddns --config=<config file>`.
By default, the config file is `/etc/ddns.conf`. By default, the config file is `/etc/ddns.conf`.
This process can be automated using systemd or cron.