Skip to content

User Guide

This page is for operators using the dashboard day to day.

Interface Map

Dashboard overview

text
Dashboard
|-- Overview: readiness, warning cards, aggregate metrics
|-- Domains: domain list and domain detail tabs
|-- Edge Network: edge nodes, pools, DNS, anycast settings
|-- Usage Analytics: traffic, cache, and bandwidth views
|-- Config Snapshots: versions, diffs, rebuild, rollback
|-- Event Viewer: diagnostics and runtime event search
|-- Security Events: WAF/rate-limit/IP/security decisions
|-- Audit Log: admin and system changes
|-- Settings: platform, PowerDNS, edge DNS, and runtime settings

Login

  1. Open http://localhost:8082 or the deployed dashboard URL.
  2. Sign in with an admin account.
  3. Confirm the top status bar shows reachable core and edge services.
  4. If status is unknown, open Settings and verify the configured core/edge browser URLs.

Local bootstrap credentials are admin / admin; replace them before any shared deployment.

Add A Domain

  1. Open Domains.
  2. Choose add domain.
  3. Enter a display name and hostname such as example.com.
  4. Save the domain.
  5. Review the nameserver instructions.
  6. Update registrar delegation when using nameserver-first onboarding.
  7. Use verify nameservers.
  8. Activate the domain after delegation checks pass, or use override only for a controlled test.

Tip: keep origin configuration separate from domain creation. Add origins after the zone exists so health checks and readiness warnings can point to the right resource.

Configure DNS

  1. Open the domain detail page.
  2. Select DNS.
  3. Add records with type, name, content, TTL, and proxy status.
  4. Use DNS-only records for mail, verification, and services that should not pass through the CDN.
  5. Use proxied records for HTTP/HTTPS traffic that should route to edge nodes.
  6. Preview routing when Geo DNS or anycast policy is enabled.

Example records:

NameTypeContentProxy
@A203.0.113.10On
wwwCNAMEexample.comOn
_acme-challengeTXTACME tokenOff
mailAMail server IPOff

Configure Origins

  1. Open Origins.
  2. Add the primary origin host, scheme, and enabled state.
  3. Add backup origins for failover.
  4. Run manual health checks after changes.
  5. Watch readiness warnings for failed or stale origin checks.

Best practice: use hostnames instead of direct IPs when your origin platform rotates infrastructure, but pin IPs for controlled internal origins.

Configure Traffic Rules

Domain tabs expose:

TabTypical task
CacheDefault TTL, query-string behavior, cache rules, purge requests.
RedirectsURL forwarding, import/export, rule tests.
Page RulesMatch URL patterns and apply behavior.
WAFBlock/challenge/log request patterns.
Rate LimitsLimit noisy clients by IP or other keys.
HeadersAdd response headers such as HSTS or CSP.
IP RulesAllow or block CIDR ranges.
SSLRequest, renew, check, or import certificates.

Purge Cache

  1. Open Cache.
  2. Choose purge scope: url, prefix, domain, or everything.
  3. Enter URL/prefix only when the selected scope needs it.
  4. Submit and check purge request history.

View Analytics

Use Usage Analytics for global views and a domain's Analytics tab for domain-scoped traffic. Buckets support minute, hour, and day.

Common checks:

  • Request volume changes after DNS activation.
  • Cache hit ratio after rule changes.
  • Bandwidth spikes after purge or bypass rules.
  • Unknown-domain warnings when edge receives traffic for unconfigured hosts.

Export Reports

The dashboard can export Markdown reports for operational snapshots. Use these for change reviews, incident notes, and handoff summaries.

Shortcuts And Tips

  • Use copy buttons for domain IDs, tokens, and diagnostics output.
  • Use table horizontal controls when narrow screens hide columns.
  • Keep browser dev tools for secondary diagnostics; the dashboard surfaces primary API errors in alerts and field messages.
  • Treat edge developer tools as local/private helpers only.

Released under the MIT License.