@serve.zone/dcrouter

The ts/ directory is the main dcrouter runtime package. It exposes the DcRouter orchestrator, IDcRouterOptions, runCli(), and the server-side exports that matter when you want to boot the full router stack from code.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Installation

pnpm add @serve.zone/dcrouter

Core Exports

Export	Purpose
`DcRouter`	Main orchestrator for proxying, DNS, email, VPN, RADIUS, remote ingress, DB, and OpsServer
`IDcRouterOptions`	Top-level configuration shape
`runCli()`	Bootstrap helper; uses OCI env-driven config when `DCROUTER_MODE=OCI_CONTAINER`
`UnifiedEmailServer` and smartmta types	Re-exported email server primitives
`RadiusServer` and related types	RADIUS server runtime exports
`RemoteIngressManager` and `TunnelManager`	Remote ingress orchestration exports
`IHttp3Config`	HTTP/3 configuration for qualifying HTTPS routes

Quick Start

import { DcRouter } from '@serve.zone/dcrouter';

const router = new DcRouter({
  smartProxyConfig: {
    routes: [
      {
        name: 'local-app',
        match: {
          domains: ['localhost'],
          ports: [18080],
        },
        action: {
          type: 'forward',
          targets: [{ host: '127.0.0.1', port: 3001 }],
        },
      },
    ],
  },
  opsServerPort: 3000,
});

await router.start();

What `DcRouter` Manages

SmartProxy for HTTP/HTTPS/TCP routes
UnifiedEmailServer for SMTP ingress and delivery when emailConfig is present
DB-backed managers for routes, API tokens, target profiles, domains, records, ACME config, and email domains when the DB is enabled
embedded authoritative DNS and DoH route generation from dnsNsDomains and dnsScopes
VPN, RADIUS, and remote ingress services when their config blocks are enabled
OpsServer and the dashboard, which start on every boot

Important Runtime Behavior

The DB is enabled by default and uses an embedded local database when no external MongoDB URL is provided.
System routes from config, email, and DNS are persisted with stable ownership and are toggle-only.
API-created routes are the only routes intended for full CRUD from the dashboard or client SDK.
Qualifying HTTPS forward routes on port 443 get HTTP/3 augmentation by default.
runCli() is the supported code-level bootstrap entrypoint; the package does not expose a separate npm bin command.

Use Another Module When...

Need	Module
A higher-level client SDK for a running router	`@serve.zone/dcrouter-apiclient` or `@serve.zone/dcrouter/apiclient`
Raw TypedRequest request/data contracts	`@serve.zone/dcrouter-interfaces` or `@serve.zone/dcrouter/interfaces`
The standalone migration runner	`@serve.zone/dcrouter-migrations`
The browser dashboard module boundary	`@serve.zone/dcrouter-web`

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

4.8 KiB Raw Blame History