mirror of
				https://github.com/axllent/mailpit.git
				synced 2025-10-31 00:07:43 +02:00 
			
		
		
		
	Update installation instructions
This commit is contained in:
		| @@ -34,7 +34,13 @@ Mailpit is inspired by [MailHog](#why-rewrite-mailhog), but much, much faster. | ||||
|  | ||||
| ## Installation | ||||
|  | ||||
| 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, or see [the wiki](https://github.com/axllent/mailpit/wiki/Runtime-options) for additional information. | ||||
| Linux & Mac users can install it directly to `/usr/local/bin/mailpit` with: | ||||
|  | ||||
| ```bash | ||||
| sudo bash < <(curl -sL https://raw.githubusercontent.com/axllent/mailpit/develop/install.sh) | ||||
| ``` | ||||
|  | ||||
| Or 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, or see [the wiki](https://github.com/axllent/mailpit/wiki/Runtime-options) for additional information. | ||||
|  | ||||
| To build Mailpit from source see [building from source](https://github.com/axllent/mailpit/wiki/Building-from-source). | ||||
|  | ||||
|   | ||||
							
								
								
									
										98
									
								
								install.sh
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										98
									
								
								install.sh
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,98 @@ | ||||
| #!/usr/bin/env bash | ||||
|  | ||||
| GH_REPO="axllent/mailpit" | ||||
| TIMEOUT=90 | ||||
|  | ||||
| set -e | ||||
|  | ||||
| VERSION=$(curl --silent --location --max-time "${TIMEOUT}" "https://api.github.com/repos/${GH_REPO}/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') | ||||
| if [ $? -ne 0 ]; then | ||||
|     echo -ne "\nThere was an error trying to check what is the latest version of ssbak.\nPlease try again later.\n" | ||||
|     exit 1 | ||||
| fi | ||||
|  | ||||
| # detect the platform | ||||
| OS="$(uname)" | ||||
| case $OS in | ||||
| Linux) | ||||
|     OS='linux' | ||||
|     ;; | ||||
| FreeBSD) | ||||
|     OS='freebsd' | ||||
|     echo 'OS not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| NetBSD) | ||||
|     OS='netbsd' | ||||
|     echo 'OS not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| OpenBSD) | ||||
|     OS='openbsd' | ||||
|     echo 'OS not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| Darwin) | ||||
|     OS='darwin' | ||||
|     ;; | ||||
| SunOS) | ||||
|     OS='solaris' | ||||
|     echo 'OS not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| *) | ||||
|     echo 'OS not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| esac | ||||
|  | ||||
| # detect the arch | ||||
| OS_type="$(uname -m)" | ||||
| case "$OS_type" in | ||||
| x86_64 | amd64) | ||||
|     OS_type='amd64' | ||||
|     ;; | ||||
| i?86 | x86) | ||||
|     OS_type='386' | ||||
|     ;; | ||||
| aarch64 | arm64) | ||||
|     OS_type='arm64' | ||||
|     ;; | ||||
| *) | ||||
|     echo 'OS type not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| esac | ||||
|  | ||||
| GH_REPO_BIN="mailpit-${OS}-${OS_type}.tar.gz" | ||||
|  | ||||
| #create tmp directory and move to it with macOS compatibility fallback | ||||
| tmp_dir=$(mktemp -d 2>/dev/null || mktemp -d -t 'mailpit-install.XXXXXXXXXX') | ||||
| cd "$tmp_dir" | ||||
|  | ||||
| echo "Downloading Mailpit $VERSION" | ||||
| LINK="https://github.com/${GH_REPO}/releases/download/${VERSION}/${GH_REPO_BIN}" | ||||
|  | ||||
| curl --silent --location --max-time "${TIMEOUT}" "${LINK}" | tar zxf - || { | ||||
|     echo "Error downloading" | ||||
|     exit 2 | ||||
| } | ||||
|  | ||||
| mkdir -p /usr/local/bin || exit 2 | ||||
| cp mailpit /usr/local/bin/ || exit 2 | ||||
| chmod 755 /usr/local/bin/mailpit || exit 2 | ||||
| case "$OS" in | ||||
| 'linux') | ||||
|     chown root:root /usr/local/bin/mailpit || exit 2 | ||||
|     ;; | ||||
| 'freebsd' | 'openbsd' | 'netbsd' | 'darwin') | ||||
|     chown root:wheel /usr/local/bin/mailpit || exit 2 | ||||
|     ;; | ||||
| *) | ||||
|     echo 'OS not supported' | ||||
|     exit 2 | ||||
|     ;; | ||||
| esac | ||||
|  | ||||
| rm -rf "$tmp_dir" | ||||
| echo "Installed successfully to /usr/local/bin/mailpit" | ||||
		Reference in New Issue
	
	Block a user