apertodns 2.0.1 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +66 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,16 +11,19 @@ ApertoDNS is a free Dynamic DNS service that lets you point a subdomain to your
11
11
 
12
12
  ## Why ApertoDNS?
13
13
 
14
- | Feature | ApertoDNS | No-IP | DuckDNS | Dynu |
15
- |---------|-----------|-------|---------|------|
16
- | Free subdomains | Unlimited | 1 (free) | 5 | 4 |
17
- | API Keys with scopes | Yes | No | No | Limited |
14
+ | Feature | ApertoDNS | Dyn (Oracle) | No-IP | DuckDNS |
15
+ |---------|-----------|--------------|-------|---------|
16
+ | Free plan | Yes | No ($55/yr) | Yes | Yes |
17
+ | Free subdomains | Unlimited | 0 | 1 | 5 |
18
+ | API Keys with scopes | Yes | No | No | No |
18
19
  | CLI tool | Yes | No | No | No |
19
- | IPv6 support | Yes | Paid | Yes | Yes |
20
- | No forced renewal | Yes | 30 days | Yes | Yes |
21
- | DynDNS2 compatible | Yes | Yes | No | Yes |
20
+ | Docker images | Yes | No | No | No |
21
+ | IPv6 support | Yes | Paid | Paid | Yes |
22
+ | No forced renewal | Yes | N/A | 30 days | Yes |
23
+ | DynDNS2 compatible | Yes | Yes | Yes | No |
22
24
  | Webhooks | Yes | No | No | No |
23
25
  | Team sharing | Yes | No | No | No |
26
+ | Open Source | Yes | No | No | No |
24
27
 
25
28
  ## Features
26
29
 
@@ -33,6 +36,7 @@ ApertoDNS is a free Dynamic DNS service that lets you point a subdomain to your
33
36
  - **IPv4 & IPv6** - Full dual-stack support
34
37
  - **Real-time Stats** - View usage statistics and logs
35
38
  - **Router/NAS Compatible** - Works with Synology, QNAP, and DynDNS2-compatible routers
39
+ - **Docker Images** - Official [apertodns/cli](https://hub.docker.com/r/apertodns/cli) and [apertodns/updater](https://hub.docker.com/r/apertodns/updater) images
36
40
 
37
41
  ## Requirements
38
42
 
@@ -94,6 +98,7 @@ apertodns --force
94
98
  | `--add-domain <name>` | Create a new subdomain |
95
99
  | `--delete-domain` | Delete a domain (interactive) |
96
100
  | `--test <domain>` | Test DNS resolution |
101
+ | `update <domain>` | Update a specific domain's IP (use with `--api-key`) |
97
102
 
98
103
  ### Token Management
99
104
 
@@ -123,7 +128,15 @@ apertodns --force
123
128
  | `--config` | Edit configuration |
124
129
  | `--logout` | Remove local configuration |
125
130
  | `--force` | Force DNS update now |
126
- | `--update` | Standalone DynDNS2 update (with `--domain` and `--token`) |
131
+
132
+ ### Standalone Update (DynDNS2)
133
+
134
+ | Command | Description |
135
+ |---------|-------------|
136
+ | `--update` | Standalone DynDNS2 update (no config required) |
137
+ | `--domain <fqdn>` | Domain to update (with --update) |
138
+ | `--token <token>` | Token for authentication (with --update) |
139
+ | `--ip <address>` | Custom IP address (optional, auto-detected if omitted) |
127
140
 
128
141
  ### Daemon Mode
129
142
 
@@ -170,7 +183,7 @@ apertodns --domains --json
170
183
  apertodns --my-ip --json
171
184
 
172
185
  # Combine with API key for scripting
173
- apertodns --api-key ak_xxx... --domains --json
186
+ apertodns --api-key apertodns_live_xxx... --domains --json
174
187
  ```
175
188
 
176
189
  ## Daemon Mode
@@ -185,6 +198,49 @@ apertodns --daemon
185
198
  apertodns --daemon --interval 60
186
199
  ```
187
200
 
201
+ ## Standalone Update
202
+
203
+ Update DNS without any saved configuration - perfect for scripts and one-off updates:
204
+
205
+ ```bash
206
+ # Auto-detect IP and update
207
+ apertodns --update --domain myserver.apertodns.com --token YOUR_TOKEN
208
+
209
+ # Specify custom IP
210
+ apertodns --update --domain myserver.apertodns.com --token YOUR_TOKEN --ip 203.0.113.42
211
+ ```
212
+
213
+ ## Docker
214
+
215
+ Run without installing Node.js:
216
+
217
+ ```bash
218
+ # Run CLI via Docker
219
+ docker run --rm apertodns/cli --help
220
+
221
+ # Interactive setup (persisted config)
222
+ docker run -it -v apertodns_config:/root/.config/apertodns apertodns/cli --setup
223
+
224
+ # List domains
225
+ docker run -v apertodns_config:/root/.config/apertodns apertodns/cli --domains
226
+
227
+ # Standalone update (no config needed)
228
+ docker run --rm apertodns/cli --update --domain myhost.apertodns.com --token YOUR_TOKEN
229
+ ```
230
+
231
+ For continuous updates, use the dedicated updater image:
232
+
233
+ ```bash
234
+ docker run -d \
235
+ --name apertodns-updater \
236
+ --restart unless-stopped \
237
+ -e TOKEN=your_token \
238
+ -e DOMAINS=myhost.apertodns.com \
239
+ apertodns/updater
240
+ ```
241
+
242
+ See [Docker Hub](https://hub.docker.com/r/apertodns/cli) for more options.
243
+
188
244
  ## Automatic Updates (Cron)
189
245
 
190
246
  Set up automatic IP updates with cron:
@@ -295,7 +351,7 @@ apertodns --add-domain newserver.apertodns.com
295
351
  apertodns --domains --json
296
352
 
297
353
  # Use API key for automation
298
- APERTODNS_API_KEY=ak_xxx... apertodns --domains --json
354
+ APERTODNS_API_KEY=apertodns_live_xxx... apertodns --domains --json
299
355
  ```
300
356
 
301
357
  ## Links
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "apertodns",
3
- "version": "2.0.1",
3
+ "version": "2.0.2",
4
4
  "description": "ApertoDNS CLI - Dynamic DNS management from your terminal. Manage domains, tokens, API keys and DNS updates with style.",
5
5
  "main": "index.js",
6
6
  "type": "module",