From f7502b1c143672d92b32f24974fc95f2ae4111b9 Mon Sep 17 00:00:00 2001 From: Ralph Slooten Date: Thu, 4 Aug 2022 23:17:01 +1200 Subject: [PATCH] Refer to wiki for build instructions --- README-BUILDING.md | 45 --------------------------------------------- README.md | 6 +++--- 2 files changed, 3 insertions(+), 48 deletions(-) delete mode 100644 README-BUILDING.md diff --git a/README-BUILDING.md b/README-BUILDING.md deleted file mode 100644 index 7ceb95b..0000000 --- a/README-BUILDING.md +++ /dev/null @@ -1,45 +0,0 @@ -# Building Mailpit from source - -Go (>= version 1.8) and npm are required to compile mailpit from source. - -``` -git clone git@github.com:axllent/mailpit.git -cd mailpit -``` - -## Building the UI - -The Mailpit web user interface is built with node. In the project's root (top) directory run the following to install the required node modules: - - -### Installing the node modules -``` -npm install -``` - - -### Building the web UI - -``` -npm run build -``` - -You can also run `npm run watch` which will watch for changes and rebuild the HTML/CSS/JS automatically when changes are detected. -Please note that you must restart Mailpit (`go run .`) to run with the changes. - - -## Build the mailpit binary - -One you have the assets compiled, you can build mailpit as follows: -``` -go build -ldflags "-s -w" -``` - -## Building a stand-alone sendmail binary - -This step is unnecessary, however if you do not intend to either symlink `sendmail` to mailpit or configure your existing sendmail to route mail to mailpit, you can optionally build a stand-alone sendmail binary. - -``` -cd sendmail -go build -ldflags "-s -w" -``` diff --git a/README.md b/README.md index c3d641e..412f84b 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Mailpit is inspired by [MailHog](#why-rewrite-mailhog), but much, much faster. Download a pre-built binary in the [releases](https://github.com/axllent/mailpit/releases/latest). The `mailpit` can be placed in your `$PATH`, or simply run as `./mailpit`. See `mailpit -h` for options. -To build mailpit from source see [building from source](README-BUILDING.md). +To build Maailpit from source see [building from source](https://github.com/axllent/mailpit/wiki/Building-from-source). ### Configuring sendmail @@ -43,11 +43,11 @@ You can use `mailpit sendmail` as your sendmail configuration in `php.ini`: sendmail_path = /usr/local/bin/mailpit sendmail ``` -If mailpit is found on the same host as sendmail, you can symlink the mailpit binary to sendmail, eg: `ln -s /usr/local/bin/mailpit /usr/sbin/sendmail` (only if mailpit is running on default 1025 port). +If Mailpit is found on the same host as sendmail, you can symlink the mailpit binary to sendmail, eg: `ln -s /usr/local/bin/mailpit /usr/sbin/sendmail` (only if Mailpit is running on default 1025 port). You can use your default system `sendmail` binary to route directly to port `1025` (configurable) by calling `/usr/sbin/sendmail -S localhost:1025`. -You can build a mailpit-specific sendmail binary from source ( see [building from source](README-BUILDING.md)). +You can build a Mailpit-specific sendmail binary from source ( see [building from source](https://github.com/axllent/mailpit/wiki/Building-from-source)). ## Why rewrite MailHog?