46 lines
948 B
Markdown
46 lines
948 B
Markdown
# DDNS
|
|
|
|
DDNS is an application that enables the automatic updating of DNS records for various providers.
|
|
|
|
Supported providers:
|
|
- Porkbun
|
|
|
|
## Build
|
|
|
|
Execute `./gradlew assemble`.
|
|
The resulting binary will be located in `./build/bin/releaseExecutable/`.
|
|
|
|
## Usage
|
|
|
|
The following command updates all A and AAAA DNS records in Porkbun for `example.com` and `test.example.com`.
|
|
|
|
```
|
|
ddns porkbun update \
|
|
--key=<key> \
|
|
--secret-key=<secret key> \
|
|
--domain=example.com \
|
|
--subdomain= \
|
|
--subdomain=test
|
|
```
|
|
|
|
Alternatively, a file can be used to declare one or more configurations.
|
|
The above example can be declared as follows.
|
|
|
|
```
|
|
[
|
|
{
|
|
"type": "porkbun",
|
|
"key": "<key>",
|
|
"secretKey": "<secret key>"
|
|
"domain": "example.com",
|
|
"subdomains": [
|
|
"",
|
|
"test"
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
To use this config file, execute the command `ddns --config=<config file>`.
|
|
By default, the config file is `/etc/ddns.conf`.
|