Guide Overview

This section helps first-time readers move from understanding the project to running it locally and extending it safely.

Sections

Getting Started

• Quick Start: boot the frontend, Worker, and docs site with the shortest path
• Open Source: understand the repository layout and contribution directions

Core Topics

• Architecture: learn how Vue, Workers, KV, and Cloudflare APIs are connected
• Auth and Permissions: review email auth, sessions, roles, and super admin rules
• Accounts and Zone Cache: understand multi-account access and scheduled zone sync
• DNS Management: learn how DNS queries, edits, and batch actions are implemented
• Mail and Security: review verification emails, notifications, secrets, and password safety

Deployment

• Deploy to Cloudflare: publish the Worker, Pages site, and custom domains

Suggested Reading Order

• For users: start with Quick Start and Deploy to Cloudflare
• For contributors: start with Open Source and then read the core topics
• For maintainers: start with Architecture and Mail and Security