Skip to content

Commit b1eda6d

Browse files
Copilottuanductran
andcommitted
Update README.md with accurate skill counts and integrations section
Co-authored-by: tuanductran <69758022+tuanductran@users.noreply.github.com>
1 parent fb356b9 commit b1eda6d

1 file changed

Lines changed: 122 additions & 7 deletions

File tree

README.md

Lines changed: 122 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,32 @@ NextDNS API integration best practices covering authentication, profile manageme
3535
| Capability | 15 | Authentication, Profile management, Security settings, Privacy settings, Parental control, Analytics queries, Time series data, Logs streaming, Error handling, Pagination |
3636
| Efficiency | 2 | Response format parsing, Logs download |
3737

38-
### nextdns-cli (10 rules)
38+
### nextdns-cli (14 rules)
3939

4040
NextDNS CLI client best practices for installation, configuration, and management of DNS-over-HTTPS proxy.
4141

4242
| Type | Count | Examples |
4343
|:-----------|:------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
44-
| Capability | 8 | Installation, Daemon control, System configuration, Profile configuration, Advanced features, Monitoring, Platform-specific, Troubleshooting |
45-
| Efficiency | 2 | Upgrade/uninstall, Best practices |
44+
| Capability | 11 | Installation, Daemon control, System configuration, Profile configuration, Advanced features, Monitoring, Platform-specific, Troubleshooting |
45+
| Efficiency | 3 | Upgrade/uninstall, Best practices, Docker deployment |
4646

47-
### nextdns-ui (8 rules)
47+
### nextdns-ui (10 rules)
4848

4949
NextDNS Web UI configuration and management best practices via the web dashboard.
5050

5151
| Type | Count | Examples |
5252
|:-----------|:------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
53-
| Capability | 6 | Security settings, Privacy settings, Parental control, Denylist/Allowlist, Analytics & Logs, Configuration management |
54-
| Efficiency | 2 | Setup optimization, Troubleshooting via UI |
53+
| Capability | 7 | Security settings, Privacy settings, Parental control, Denylist/Allowlist, DDNS settings, Analytics & Logs, Configuration management |
54+
| Efficiency | 3 | Threat modeling, Setup optimization, Troubleshooting via UI |
55+
56+
### integrations (3 rules)
57+
58+
NextDNS integration guides for third-party platforms and services including routers, network management, and home automation.
59+
60+
| Type | Count | Examples |
61+
|:-----------|:------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
62+
| Capability | 3 | DNSMasq integration, Public DNS and AdGuard Home, OpenWrt installation and troubleshooting |
63+
| Efficiency | 0 | Future: Multi-platform deployment, Integration testing |
5564

5665
## Rule Types
5766

@@ -129,14 +138,33 @@ Rules are classified into two categories:
129138
- **Privacy Settings**: Blocklists and tracking protection
130139
- **Parental Control**: Advanced filtering and schedules
131140
- **Denylist/Allowlist**: Manual domain management
141+
- **DDNS Settings**: Dynamic DNS configuration
132142

133143
#### Monitoring & Management
134144

135145
- **Analytics & Logs**: Identify and analyze network traffic
136146
- **Configuration Management**: Profile settings and performance
147+
- **Threat Modeling**: Security risk assessment and mitigation
137148
- **Setup Optimization**: Best practices for dashboard setup
138149
- **Troubleshooting UI**: Debugging issues using the web interface
139150

151+
### NextDNS Integration Skills
152+
153+
#### Platform Integration
154+
155+
- **DNSMasq Integration**: Configure DNSMasq and NextDNS together while maintaining client reporting
156+
- **Public DNS Setup**: Configure NextDNS public DNS servers on browsers and operating systems
157+
- **AdGuard Home**: Integrate NextDNS with AdGuard Home as upstream DNS provider
158+
- **OpenWrt**: Installation, upgrade, and troubleshooting on OpenWrt routers
159+
160+
#### Supported Platforms
161+
162+
- Routers: OpenWrt, pfSense, Ubiquiti UniFi, DD-WRT
163+
- Network: DNSMasq, AdGuard Home, conditional DNS forwarding
164+
- Automation: Home Assistant, Tailscale
165+
- Containers: Docker, Kubernetes
166+
- NAS: Synology, QNAP
167+
140168
## Quick Examples
141169

142170
### API Examples
@@ -227,6 +255,52 @@ nextdns cache-stats
227255
nextdns discovered
228256
```
229257

258+
### Integration Examples
259+
260+
#### DNSMasq with NextDNS
261+
262+
```bash
263+
# Configure DNSMasq to use NextDNS on custom port
264+
# In /etc/dnsmasq.conf
265+
server=127.0.0.1#5342
266+
no-resolv
267+
268+
# Configure NextDNS CLI to listen on port 5342
269+
sudo nextdns config set -listen=127.0.0.1:5342
270+
sudo nextdns restart
271+
```
272+
273+
#### OpenWrt Installation
274+
275+
```bash
276+
# SSH into OpenWrt router
277+
ssh root@192.168.1.1
278+
279+
# Install NextDNS
280+
sh -c 'sh -c "$(curl -sL https://nextdns.io/install)"'
281+
282+
# Configure profile ID
283+
nextdns config set -profile=abc123
284+
285+
# Install and start service
286+
nextdns install
287+
/etc/init.d/nextdns start
288+
/etc/init.d/nextdns enable
289+
```
290+
291+
#### AdGuard Home Integration
292+
293+
Configure NextDNS as upstream DNS in AdGuard Home settings:
294+
295+
```text
296+
# Upstream DNS Servers
297+
https://dns.nextdns.io/abc123
298+
299+
# Bootstrap DNS Servers
300+
1.1.1.1
301+
1.0.0.1
302+
```
303+
230304
## Methodology
231305

232306
Every skill in this repository is created through a rigorous, evidence-based process:
@@ -255,9 +329,50 @@ Skills are tested with:
255329

256330
## Resources
257331

332+
### Official Documentation
333+
258334
- [NextDNS API Documentation](https://nextdns.github.io/api/)
259-
- [NextDNS Account](https://my.nextdns.io/account)
335+
- [NextDNS CLI Wiki](https://github.com/nextdns/nextdns/wiki)
260336
- [NextDNS Help Center](https://help.nextdns.io)
337+
- [NextDNS Account Management](https://my.nextdns.io/account)
338+
339+
### Community Resources
340+
341+
- [NextDNS-Config Community Guidelines](https://github.com/yokoffing/NextDNS-Config)
342+
343+
## Contributing
344+
345+
This repository follows strict quality standards to ensure AI agents can reliably use the skills.
346+
347+
### Development Setup
348+
349+
```bash
350+
# Install dependencies
351+
pnpm install
352+
353+
# Run linting
354+
pnpm lint
355+
356+
# Fix linting issues
357+
pnpm lint:fix
358+
```
359+
360+
### Adding a New Rule
361+
362+
1. Use the template from `templates/rule-template.md`
363+
2. Create a new file in `skills/<skill-name>/rules/` using kebab-case naming
364+
3. Add required YAML frontmatter (title, impact, impactDescription, type, tags)
365+
4. Include the H1 title followed by the bolded Impact Line
366+
5. Add the entry to the skill's capability or efficiency table in `SKILL.md`
367+
6. Run `pnpm lint:fix` to ensure compliance
368+
369+
### Quality Requirements
370+
371+
- **Language**: All content must be in English
372+
- **Indentation**: Use 4-space indentation for lists
373+
- **Filenames**: Use kebab-case for all rule files
374+
- **Case Police**: Follow technical term casing (NextDNS, OpenWrt, macOS, etc.)
375+
- **Code Blocks**: Always specify language for syntax highlighting
261376

262377
## License
263378

0 commit comments

Comments
 (0)