diff --git a/README.md b/README.md index afd74d4..3a5afa6 100644 --- a/README.md +++ b/README.md @@ -17,28 +17,28 @@ Mailpit was originally **inspired** by MailHog which is [no longer maintained](h ## Features -- Runs entirely from a single static binary -- SMTP server (default: `0.0.0.0:1025`) -- Web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments including image thumbnails) -- HTML check to test & score mail client compatibility with HTML emails -- Link check to test message links (HTML & text) & linked images -- Screenshots of HTML messages via web UI ([see wiki](https://github.com/axllent/mailpit/wiki/HTML-screenshots)) +- Runs entirely from a single [static binary](https://mailpit.axllent.org/docs/install/) +- Modern web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments +including image thumbnails), including optional [HTTPS](https://mailpit.axllent.org/docs/configuration/https/) +- Optional [basic authentication](https://mailpit.axllent.org/docs/configuration/frontend-authentication/) for web UI & API +- [HTML check](https://mailpit.axllent.org/docs/usage/html-check/) to test & score mail client compatibility with HTML emails +- [Link check](https://mailpit.axllent.org/docs/usage/link-check/) to test message links (HTML & text) & linked images +- [Create screenshots](https://mailpit.axllent.org/docs/usage/html-screenshots/) of HTML messages via web UI - Mobile and tablet HTML preview toggle in desktop mode -- Light & dark web UI themes with auto-detect -- Advanced mail search ([see wiki](https://github.com/axllent/mailpit/wiki/Mail-search)) -- Message tagging ([see wiki](https://github.com/axllent/mailpit/wiki/Tagging)) -- Real-time web UI updates using web sockets for new mail -- Optional browser notifications for new mail (when accessed via either HTTPS or `localhost` only) +- Advanced [mail search](https://mailpit.axllent.org/docs/usage/search-filters/) +- [Message tagging](https://mailpit.axllent.org/docs/usage/tagging/) +- Real-time web UI updates using web sockets for new mail & optional browser notifications for new mail (when accessed +via either HTTPS or `localhost` only) +- SMTP server with optional [STARTTLS & SMTP authentication](https://mailpit.axllent.org/docs/configuration/smtp-authentication/) (including an +"accept any" mode) +- [SMTP relaying](https://mailpit.axllent.org/docs/configuration/smtp-relay/) (message release) - relay messages via a different SMTP server +including an optional allowlist of accepted recipients +- Fast SMTP processing & storing - approximately 70-100 emails per second depending on CPU, network speed & email size, +easily handling tens of thousands of emails - Configurable automatic email pruning (default keeps the most recent 500 emails) -- Email storage either in a temporary or persistent database ([see wiki](https://github.com/axllent/mailpit/wiki/Email-storage)) -- Fast SMTP processing & storing - approximately 70-100 emails per second depending on CPU, network speed & email size, easily handling tens of thousands of emails -- SMTP relaying / message release - relay messages via a different SMTP server including an optional allowlist of accepted recipients ([see wiki](https://github.com/axllent/mailpit/wiki/SMTP-relay)) -- Optional SMTP with STARTTLS & SMTP authentication, including an "accept anything" mode ([see wiki](https://github.com/axllent/mailpit/wiki/SMTP-with-STARTTLS-and-authentication)) -- Optional HTTPS for web UI ([see wiki](https://github.com/axllent/mailpit/wiki/HTTPS)) -- Optional basic authentication for web UI ([see wiki](https://github.com/axllent/mailpit/wiki/Basic-authentication)) -- A simple REST API ([see docs](docs/apiv1/README.md)) -- Optional webhook for received messages ([see docs](https://github.com/axllent/mailpit/wiki/Webhook)) -- Multi-architecture [Docker images](https://github.com/axllent/mailpit/wiki/Docker-images) +- A simple [REST API](https://mailpit.axllent.org/docs/api-v1/) for integration testing +- Optional [webhook](https://mailpit.axllent.org/docs/integration/webhook/) for received messages +- Multi-architecture [Docker images](https://mailpit.axllent.org/docs/install/docker/) ## Installation @@ -71,26 +71,28 @@ Static binaries can always be found on the [releases](https://github.com/axllent ### Docker -See [Docker instructions](https://github.com/axllent/mailpit/wiki/Docker-images) for 386, amd64 & arm64 images. +See [Docker instructions](https://mailpit.axllent.org/docs/install/docker/) for 386, amd64 & arm64 images. ### Compile from source -To build Mailpit from source, see [Building from source](https://github.com/axllent/mailpit/wiki/Building-from-source). +To build Mailpit from source, see [Building from source](https://mailpit.axllent.org/docs/install/source/). ## Usage -Run `mailpit -h` to see options. More information can be seen in [the docs](https://github.com/axllent/mailpit/wiki/Runtime-options). +Run `mailpit -h` to see options. More information can be seen in [the docs](https://mailpit.axllent.org/docs/configuration/runtime-options/). If installed using homebrew, you may run `brew services start mailpit` to always run mailpit automatically. ### Testing Mailpit -Please refer to [the documentation](https://github.com/axllent/mailpit/wiki/Testing-Mailpit) on how to easily test email delivery to Mailpit. +Please refer to [the documentation](https://mailpit.axllent.org/docs/install/testing/) on how to easily test email delivery to Mailpit. ### Configuring sendmail -Mailpit's SMTP server (default on port 1025), so you will likely need to configure your sending application to deliver mail via that port. A common MTA (Mail Transfer Agent) that delivers system emails to an SMTP server is `sendmail`, used by many applications, including PHP. Mailpit can also act as substitute for sendmail. For instructions on how to set this up, please refer to the [sendmail documentation](https://github.com/axllent/mailpit/wiki/Configuring-sendmail). +Mailpit's SMTP server (default on port 1025), so you will likely need to configure your sending application to deliver mail via that port. +A common MTA (Mail Transfer Agent) that delivers system emails to an SMTP server is `sendmail`, used by many applications, including PHP. +Mailpit can also act as substitute for sendmail. For instructions on how to set this up, please refer to the [sendmail documentation](https://mailpit.axllent.org/docs/install/sendmail/). diff --git a/cmd/reindex.go b/cmd/reindex.go index 97ad990..e1120c0 100644 --- a/cmd/reindex.go +++ b/cmd/reindex.go @@ -1,7 +1,3 @@ -/* -Copyright © 2022-Now() Ralph Slooten -This file is part of a CLI application. -*/ package cmd import ( diff --git a/cmd/root.go b/cmd/root.go index d5715c1..6e2ef4f 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -29,7 +29,7 @@ It acts as an SMTP server, and provides a web interface to view all captured ema Documentation: https://github.com/axllent/mailpit - https://github.com/axllent/mailpit/wiki`, + https://mailpit.axllent.org/docs/`, Run: func(_ *cobra.Command, _ []string) { if err := config.VerifyConfig(); err != nil { logger.Log().Error(err.Error()) diff --git a/docs/apiv1/README.md b/docs/apiv1/README.md index 682f523..83e2429 100644 --- a/docs/apiv1/README.md +++ b/docs/apiv1/README.md @@ -4,7 +4,7 @@ Mailpit provides a simple REST API to access and delete stored messages. If the Mailpit server is set to use Basic Authentication, then API requests must use Basic Authentication too. -You can view the Swagger API documentation directly within Mailpit by going to `http://0.0.0.0:8025/api/v1/`. +You can view the Swagger API documentation directly within Mailpit by going to https://mailpit.axllent.org/docs/api-v1/. The API is split into four main parts: diff --git a/server/ui-src/components/AboutMailpit.vue b/server/ui-src/components/AboutMailpit.vue index e0f6702..4e7add9 100644 --- a/server/ui-src/components/AboutMailpit.vue +++ b/server/ui-src/components/AboutMailpit.vue @@ -179,8 +179,7 @@ export default {
- + Documentation