DNS Management System Design Document

Overview

The DNS Management System provides a unified interface for managing DNS zones and records through bidirectional synchronization with a Technitium DNS Server. The system is integrated into the Local dashboard section and allows users to manage their DNS infrastructure through a single interface while maintaining consistency between the local database and the DNS server.

Architecture

System Components

Frontend Interface
- Location: /apps/dodev/app/dashboard/local/zones/page.tsx
- Purpose: Primary UI for DNS zone and record management
- Features:
  - Location-based zone organization
  - Real-time DNS zone import from Technitium server
  - CRUD operations for domains and DNS records
  - Enable/disable status management
  - Visual status indicators (green/orange badges)
API Layer
- Base path: /apps/dodev/app/api/dns/
- Routes:
  - domains/ - Domain CRUD operations
  - records/ - DNS record management
  - zones/import/ - Import zones from Technitium
  - zones/sync/ - Sync operations
  - zones/toggle/ - Enable/disable zones
DNS Client Library
- Location: /apps/dodev/lib/dns-client.ts
- Purpose: TypeScript client for Technitium DNS Server API
- Features:
  - Authentication management
  - Zone and record operations
  - Error handling with custom TechnitiumAPIError class
Database Layer
- Platform: Convex
- Tables:
  - loc_locations - Physical/logical locations
  - loc_domains - DNS domains/zones
  - loc_zones - DNS A records

Key Features

1. Bidirectional Synchronization

All CRUD operations update both the local Convex database and the Technitium DNS server simultaneously, ensuring data consistency across systems.

2. Location-Based Organization

DNS zones are organized by locations, allowing for geographical or logical grouping of DNS resources.

3. Real-Time Import

Users can import existing zones from the Technitium DNS server with a single click, automatically populating the local database.

4. Status Management

Each domain and DNS record can be enabled or disabled, with visual indicators showing the current status.

5. Comprehensive CRUD Operations

Full create, read, update, and delete operations for both domains and DNS records.

Technical Implementation

DNS Client Integration

// DNS Client Usage Example
import { DNSClient } from '@/lib/dns-client';

const client = new DNSClient(
  process.env.TECHNITIUM_DNS_URL!,
  process.env.TECHNITIUM_USERNAME!,
  process.env.TECHNITIUM_PASSWORD!
);

// Get zones from Technitium
const zones = await client.getZones();

// Add a new zone
await client.addZone('example.com', 'Primary');

// Add an A record
await client.addRecord('example.com', 'www', 'A', '192.168.1.100');

API Route Structure

// Example API route for domain operations
// apps/dodev/app/api/dns/domains/route.ts
export async function POST(request: Request) {
  const data = await request.json();
  
  // Create in Convex database
  const domain = await ctx.db.insert("loc_domains", {
    name: data.name,
    locationId: data.locationId,
    isEnabled: true,
    createdAt: Date.now()
  });
  
  // Create in Technitium DNS server
  await dnsClient.addZone(data.name, 'Primary');
  
  return Response.json({ success: true, domain });
}

Database Schema

// Convex schema definitions
export const locLocations = defineTable({
  name: v.string(),
  description: v.optional(v.string()),
  isEnabled: v.boolean(),
  createdAt: v.number(),
}).index("by_name", ["name"]);

export const locDomains = defineTable({
  name: v.string(),
  locationId: v.id("loc_locations"),
  isEnabled: v.boolean(),
  createdAt: v.number(),
}).index("by_location", ["locationId"])
  .index("by_name", ["name"]);

export const locZones = defineTable({
  domainId: v.id("loc_domains"),
  name: v.string(),
  type: v.string(),
  value: v.string(),
  ttl: v.optional(v.number()),
  isEnabled: v.boolean(),
  createdAt: v.number(),
}).index("by_domain", ["domainId"])
  .index("by_name_type", ["name", "type"]);