apertodns 1.0.0 → 1.0.1
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.
- package/README.md +77 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
|
-
# ApertoDNS
|
|
1
|
+
# ApertoDNS
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/apertodns)
|
|
4
|
+
[](https://github.com/apertonetwork/apertodns/blob/main/LICENSE)
|
|
5
|
+
[](https://nodejs.org)
|
|
6
|
+
|
|
7
|
+
**Dynamic DNS management from your terminal.** Manage domains, tokens, and DNS updates with style.
|
|
8
|
+
|
|
9
|
+
ApertoDNS is a free Dynamic DNS service that lets you point a subdomain to your dynamic IP address. Perfect for home servers, IoT devices, game servers, and remote access.
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- **Easy Setup** - Login or register directly from CLI
|
|
14
|
+
- **Multiple Domains** - Manage unlimited subdomains
|
|
15
|
+
- **Auto Updates** - Set up cron for automatic IP updates
|
|
16
|
+
- **Interactive Mode** - Beautiful terminal UI with menus
|
|
17
|
+
- **IPv4 & IPv6** - Full dual-stack support
|
|
18
|
+
- **Real-time Stats** - View usage statistics and logs
|
|
19
|
+
|
|
20
|
+
## Requirements
|
|
21
|
+
|
|
22
|
+
- Node.js 18.0.0 or higher
|
|
23
|
+
- An ApertoDNS account ([register free](https://apertodns.com))
|
|
4
24
|
|
|
5
25
|
## Installation
|
|
6
26
|
|
|
@@ -11,25 +31,23 @@ npm install -g apertodns
|
|
|
11
31
|
## Quick Start
|
|
12
32
|
|
|
13
33
|
```bash
|
|
14
|
-
# Setup (login or register)
|
|
34
|
+
# 1. Setup (login or register)
|
|
15
35
|
apertodns --setup
|
|
16
36
|
|
|
17
|
-
# View dashboard
|
|
37
|
+
# 2. View your dashboard
|
|
18
38
|
apertodns --dashboard
|
|
19
39
|
|
|
20
|
-
# List your domains
|
|
40
|
+
# 3. List your domains
|
|
21
41
|
apertodns --domains
|
|
22
42
|
|
|
23
|
-
#
|
|
24
|
-
apertodns --
|
|
25
|
-
|
|
26
|
-
# Test DNS resolution
|
|
27
|
-
apertodns --test google.com
|
|
43
|
+
# 4. Force DNS update
|
|
44
|
+
apertodns --force
|
|
28
45
|
```
|
|
29
46
|
|
|
30
47
|
## Commands
|
|
31
48
|
|
|
32
49
|
### Main Commands
|
|
50
|
+
|
|
33
51
|
| Command | Description |
|
|
34
52
|
|---------|-------------|
|
|
35
53
|
| `--dashboard` | Complete dashboard with all info |
|
|
@@ -39,37 +57,78 @@ apertodns --test google.com
|
|
|
39
57
|
| `--logs` | Recent activity logs |
|
|
40
58
|
|
|
41
59
|
### Domain Management
|
|
60
|
+
|
|
42
61
|
| Command | Description |
|
|
43
62
|
|---------|-------------|
|
|
44
|
-
| `--add-domain <name>` | Create a new
|
|
63
|
+
| `--add-domain <name>` | Create a new subdomain |
|
|
45
64
|
| `--delete-domain` | Delete a domain (interactive) |
|
|
46
65
|
| `--test <domain>` | Test DNS resolution |
|
|
47
66
|
|
|
48
67
|
### Token Management
|
|
68
|
+
|
|
49
69
|
| Command | Description |
|
|
50
70
|
|---------|-------------|
|
|
51
71
|
| `--enable <id>` | Enable a token |
|
|
52
72
|
| `--disable <id>` | Disable a token |
|
|
53
73
|
| `--toggle <id>` | Toggle token state |
|
|
74
|
+
| `--verify` | Verify token validity |
|
|
54
75
|
|
|
55
76
|
### Configuration
|
|
77
|
+
|
|
56
78
|
| Command | Description |
|
|
57
79
|
|---------|-------------|
|
|
58
80
|
| `--setup` | Guided setup (login/register) |
|
|
59
|
-
| `--status` | Show current status |
|
|
60
|
-
| `--force` | Force DNS update |
|
|
81
|
+
| `--status` | Show current status and IP |
|
|
82
|
+
| `--force` | Force DNS update now |
|
|
83
|
+
| `--cron` | Silent mode for cron jobs |
|
|
61
84
|
|
|
62
85
|
## Interactive Mode
|
|
63
86
|
|
|
64
|
-
Run `apertodns` without arguments for interactive menu.
|
|
87
|
+
Run `apertodns` without arguments for an interactive menu with all options.
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
apertodns
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Automatic Updates (Cron)
|
|
65
94
|
|
|
66
|
-
|
|
95
|
+
Set up automatic IP updates with cron:
|
|
67
96
|
|
|
68
97
|
```bash
|
|
69
|
-
#
|
|
70
|
-
*/5 * * * * apertodns --cron
|
|
98
|
+
# Update every 5 minutes
|
|
99
|
+
*/5 * * * * /usr/local/bin/apertodns --cron >> /var/log/apertodns.log 2>&1
|
|
100
|
+
|
|
101
|
+
# Or every minute for faster updates
|
|
102
|
+
* * * * * /usr/local/bin/apertodns --cron
|
|
71
103
|
```
|
|
72
104
|
|
|
105
|
+
Find your apertodns path with: `which apertodns`
|
|
106
|
+
|
|
107
|
+
## Router Integration (DynDNS2)
|
|
108
|
+
|
|
109
|
+
ApertoDNS is compatible with routers that support DynDNS2 protocol:
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
Server: api.apertodns.com
|
|
113
|
+
Protocol: DynDNS2
|
|
114
|
+
Username: your-token
|
|
115
|
+
Password: your-token
|
|
116
|
+
Hostname: yourdomain.apertodns.com
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Links
|
|
120
|
+
|
|
121
|
+
- **Website**: [apertodns.com](https://apertodns.com)
|
|
122
|
+
- **Dashboard**: [apertodns.com/dashboard](https://apertodns.com/dashboard)
|
|
123
|
+
- **API Docs**: [apertodns.com/docs](https://apertodns.com/docs)
|
|
124
|
+
- **Issues**: [GitHub Issues](https://github.com/apertonetwork/apertodns/issues)
|
|
125
|
+
|
|
126
|
+
## Support
|
|
127
|
+
|
|
128
|
+
Need help?
|
|
129
|
+
- Open an issue on [GitHub](https://github.com/apertonetwork/apertodns/issues)
|
|
130
|
+
- Email: support@apertodns.com
|
|
131
|
+
|
|
73
132
|
## License
|
|
74
133
|
|
|
75
|
-
MIT - Aperto Network
|
|
134
|
+
MIT - [Aperto Network](https://apertodns.com)
|