Skip to content

Commit 66ac9e7

Browse files
committed
instruct
1 parent 11052aa commit 66ac9e7

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# hcpp-mailcatcher
22
A plugin for Hestia Control Panel (via hesitacp-pluginable) that furnishes multitenancy services for simulated SMTP, sendmail, and a unique web GUI for previewing all outgoing emails for each user/web domain.
33

4-
 
5-
> :warning: !!! Note: this repo is in progress; when completed, a release will appear in the release tab.
64

75
## Attribution
86
Based on the slick interface and work from [MailDev](https://github.com/maildev/maildev) and a simulated sendmail compatible command line utility, [catchmail-node](https://github.com/xavierpriour/catchmail-node), these projects have been included and modified with new multitenant capabilities and enhanced compatibility to work "out-of-the-box" under the HestiaCP based control panel.
97

108
## Usage
11-
Use MailCatcher to test applications that send mail via the local built-in SMTP server and/or sendmail (like PHP's mail() function); this plugin will rename the existing `/usr/sbin/sendmail` to `/usr/sbin/sendmail.sav` and symlink to our sendmail replacement. Unique credentials for the SMTP services can be found in `/home/<username>/web/<domain>/private/smtp.json`. Default SMTP port is 2525 and the username must match the given `<domain>` name. The built-in GUI web client can be found at the URL path `http(s)://<domain>/mailcatcher` and as an envelope icon in HestiaCP's web domain listing and edit pages.
9+
Use MailCatcher to test applications that send mail via the local built-in SMTP server and/or sendmail (like PHP's mail() function); this plugin will rename the existing `/usr/sbin/sendmail` to `/usr/sbin/sendmail.sav` and symlink to our sendmail replacement. Unique credentials for the SMTP services can be found in `/home/<username>/web/<domain>/private/smtp.json`. Default SMTP port is 2525 and the username must match the given `<domain>` name.
10+
11+
The built-in GUI web client can be found at the URL path `http(s)://<domain>/mailcatcher` and as an envelope icon in HestiaCP's web domain listing and edit pages.
12+
13+
If you install mailcatcher ***after*** you have already created sites; then you must suspend/unsuspned the given site to initialize mailcatcher services for your domain.
1214

1315

1416
## Installation

0 commit comments

Comments
 (0)