3.9 KiB
@serve.zone/dcrouter-web
Browser UI package for dcrouter's operations dashboard. 🖥️
This package contains the browser entrypoint, app state, router, and web components that power the Ops dashboard served by dcrouter.
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.
What Is In Here
| Path | Purpose |
|---|---|
index.ts |
Browser entrypoint that initializes routing and renders <ops-dashboard> |
appstate.ts |
Central reactive state and action definitions |
router.ts |
URL-based dashboard routing |
elements/ |
Dashboard views and reusable UI pieces |
Main Views
The dashboard currently includes views for:
- overview and configuration
- network activity and route management
- source profiles, target profiles, and network targets
- email activity and email domains
- DNS providers, domains, DNS records, and certificates
- API tokens and users
- VPN, remote ingress, logs, and security views
Route Management UX
The web UI reflects dcrouter's current route ownership model:
- system routes are shown separately from user routes
- system routes are visible and toggleable
- system routes are not directly editable or deletable
- API routes are fully managed through the route-management forms
How It Talks To dcrouter
The frontend uses TypedRequest and shared interfaces from @serve.zone/dcrouter-interfaces.
State actions in appstate.ts fetch and mutate:
- stats and health
- logs
- routes and tokens
- certificates and ACME config
- DNS providers, domains, and records
- email domains and email operations
- VPN, remote ingress, and RADIUS data
Development Notes
The browser bundle is built from this package and served by the main dcrouter package.
pnpm run bundle
pnpm run watch
The generated bundle is written into dist_serve/ by the main build pipeline.
When To Use This Package
- Use it if you want the dashboard frontend as a package/module boundary.
- Use the main
@serve.zone/dcrouterpackage if you want the server that actually serves this UI.
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.
Company Information
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.