Skip to content

CinderHillsDev/dispatch-docs

Repository files navigation

Dispatch Docs

Documentation site for Dispatch (the self-hosted email relay), published at https://docs.dispatchrelay.app via Cloudflare Pages.

Astro + Starlight. Kept in its own repo (separate from the product repo) so the docs can be built and deployed independently of the product's release cycle.

Develop

npm install
npm run dev      # local dev server
npm run build    # static output in dist/

Deploy

Cloudflare Pages, connected to this repo:

  • Build command: npm run build
  • Output directory: dist
  • Custom domain: docs.dispatchrelay.app (set in the Cloudflare Pages dashboard - no CNAME file needed)

The site builds at base: '/'; Markdown uses base-less root-relative links (e.g. /sending/smtp/).

Contributing & security

Corrections and new guides are welcome - see CONTRIBUTING.md. Report security issues privately per SECURITY.md. This site documents the free, open-source (Apache-2.0) Dispatch project; the product lives in dispatch-platform.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors