Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.7 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.7 KB
Raw

icon Hermes, mail service

Hermes is an open-source edge email sending service, which is designed to be easy to setup and use.

Example: https://hermes.csie.cool/

English Chinese
en zh

Features

Ease of Use

  • Manage the service through a web UI
  • I18n support (currently, English and Chinese)

Secure

  • Token-based Authentication
  • Address and Domain Allowlist
  • Auto Expiration

Getting Started

First, you need to have a domain managed by Cloudflare.

  1. Fork the repository
  2. Setup the Cloudflare Pages for your forked repository
  3. Binding a D1 database to your Cloudflare Pages project as D1
  4. Open the setup page in your browser!

All of the above can be done in the browser! No need to install anything.

It uses Mailchannels under the hood, so you also need to setup the Domain Lockdown before sending emails. (Adding _mailchannels TXT record with value v=mc1 cfid=your-hermes.pages.dev to your domain)

API Usage

Once you have generated a token, you can use the API to send emails.

See OpenAPI documentation for more information.

Credits

The icon is based on Boxicons https://boxicons.com/.