summaryrefslogtreecommitdiff
path: root/README.md
blob: fef2eafe1f266eccc868a37b5c41880d0562209a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Dynamic DNS Client for Porkbun API 

A simple program for keeping all of your A records up to date!
Written in Go with only the standard library.

To use, you will need your own Porkbun API key + secret.
Then, place the `dynamic-dns` executable in a folder.
Create a new file in the same folder named `.env`. 
Copy the text below into the `.env` file, replacing the example information with your own.

Note: only include top-level domain, it'll take care of identifying and updating subdomain IPs

```
 {
  "secretapikey": "XXXXXXXXXXXXX",
  "apikey": "XXXXXXXXXXXXX",
  "domains": [
    "example.com",
    "example.net",
    "example.io"
  ]
}
```

You are now ready to run the program!

I recommend scheduling the program with something like cron.

Source code is included, you can build it yourself if you want but the executable is up to date.