Skip to content

README.md

Latest commit

 

History

History
63 lines (47 loc) · 2.6 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.6 KB
Raw

VeilHub Documentation

Last updated: 2026-04-26 00:01 (PDT)

VeilHub 1.0.0 is a self-hosted encrypted redirect-link tool for Cloudflare Workers.

All public documentation is English only.

Reading Order

For first-time deployers:

  1. Quickstart
  2. Deployment
  3. Legal Risk Statement
  4. Threat Model

For security review:

  1. Threat Model
  2. Security Design
  3. Architecture
  4. Security Policy

For compliance and public operation:

  1. Legal Risk Statement
  2. Privacy Policy Template
  3. Maintenance
  4. Repository Boundaries

For AI-assisted deployment:

  1. AI Deployment Handoff
  2. Deployment
  3. Troubleshooting

Document Index

Document Purpose
Quickstart Shortest deployment path.
Deployment Complete Cloudflare deployment and configuration reference.
Architecture Worker routes, KV data model, auth flow, and link lifecycle.
Share Link Delivery Public redirect-link behavior and domain separation.
Threat Model What VeilHub protects, what it does not protect, and why.
Security Design Cryptographic and session design.
Legal Risk Statement Operator responsibility and jurisdiction-specific legal considerations.
Privacy Policy Template Template for deployers; not legal advice.
AI Deployment Handoff Protocol for AI coding agents deploying VeilHub.
Repository Boundaries What belongs in public git and what must remain local.
Troubleshooting Common deployment and runtime problems.
Maintenance Secret rotation, owner recovery, and operational care.
Release Checklist Pre-release and post-deploy validation.
Development Plan Conservative scope and future work.

Documentation Rules

  • Document implemented behavior only.
  • Do not imply anonymity, legal compliance, or platform-level protection.
  • Use placeholders for domains, zones, tokens, and resource IDs.
  • Keep legal and operator responsibility language intact.
  • Update docs when routes, secrets, auth behavior, or storage semantics change.