d5df5baca1
DuckDNS's API is smaller than the other providers' (no list/read API, no arbitrary sub-records, one A/AAAA + one TXT record per domain), so domains are entered by the operator instead of auto-discovered, and getRecords reads from public DNS since there's nothing else to query. Documented as a free option in the README and DNS provider docs.
Documentation
This directory contains the GitHub Pages documentation site for the Proxy project.
Live site: https://theta42.github.io/proxy/
Pages
index.md- Home page with project overviewinstallation.md- Installation and setup guideapi.md- Complete API referencearchitecture.md- System architecture and designcontributing.md- Development and contribution guide
Local Preview
To preview the site locally:
# Install Jekyll (one-time setup)
gem install jekyll bundler
# Run local server
cd docs
jekyll serve
# View at http://localhost:4000/proxy/
Theme
The site uses the Cayman theme (jekyll-theme-cayman). Configuration is in _config.yml.
Updating Documentation
- Edit markdown files in this directory
- Commit and push to master branch
- GitHub Pages automatically rebuilds (may take 1-2 minutes)
- Changes visible at https://theta42.github.io/proxy/