Skip to content

Latest commit

 

History

History
137 lines (88 loc) · 6.23 KB

Installation.md

File metadata and controls

137 lines (88 loc) · 6.23 KB

smtp4dev is available via the following distribution methods:

See Getting started for info on how to use it once you have installed and started smtp4dev.

How to install smtp4dev with winget

Windows Package Manager (winget) is the easiest way to install smtp4dev on Windows 10/11.

winget install smtp4dev

Or use the full package identifier:

winget install RnwoodLtd.smtp4dev

After installation, you can start smtp4dev by running:

smtp4dev

To update smtp4dev to the latest version:

winget upgrade smtp4dev

To uninstall:

winget uninstall smtp4dev

Note: The winget package provides the portable console version of smtp4dev. For the desktop GUI version, download it from GitHub releases.

System Requirements:

  • Windows 10 1809 (build 17763) or newer
  • Windows Package Manager (winget) - usually pre-installed on Windows 11, available from Microsoft Store on Windows 10

Downloading from github releases

If you don't want to use the dotnet global tool or Docker (see below if you know what those mean), you can download a standalone (or .NET Core runtime dependent) release from github.

  • Download a release and unzip. To choose the right file, refer to the table below:
Prefix Description
Rnwood.Smtp4dev-win-x64 Windows x64 (Intel 64 bit) binary standalone
Rnwood.Smtp4dev-noruntime Architecture dependent version. Should run on any platform where the .NET 8+ runtime is installed
Rnwood.Smtp4dev-linux-x64 Linux x64 (Intel 64 bit) binary standalone
Rnwood.Smtp4dev-linux-musl-x64 Linux x64 (Intel 64 bit) binary standalone for MUSL based distros (Alpine Linux)
Rnwood.Smtp4dev-linux-arm Linux ARM (Intel 32 bit) binary standalone
Rnwood.Smtp4dev-win-arm Windows ARM 32-bit binary standalone

  • On Linux chmod +x the Rnwood.Smtp4dev file to make it executable

  • Edit appsettings.json and set the port number you want the SMTP server to listen on.

  • Run Rnwood.Smtp4dev (.exe on Windows). (If you downloaded the noruntime version, you need the .NET Core 3.1 (.NET 6.0 if using smtp4dev version >= 3.2.x) runtime on your machine and you should execute dotnet Rnwood.Smtp4dev.dll to run it.)

How to run smtp4dev as a dotnet global tool

If you're using the .NET 8+ SDK you can install smtp4dev as a global tool using the following command:

dotnet tool install -g Rnwood.Smtp4dev

The above will install the most recent non pre-release version.

If you want to use the pre-release development versions, add --prerelease

Then you can start smtp4dev by running

smtp4dev

How to run smtp4dev in Docker

Docker images for both Windows and Linux are available. To run with the web interface on port 5000 and SMTP on port 2525:

docker run --rm -it -p 5000:80 -p 2525:25 -p 110:110 rnwood/smtp4dev

Remove --rm -it if you want to leave smtp4dev running in the background, otherwise it will run until you hit CTRL+C.

The above will install the most recent non pre-release version. If you want to use the pre-release development versions use rnwood/smtp4dev:prerelease. Both 'latest' and 'prerelease' are cross platform tag which will work on either Windows x64 or Linux x64. To see the full list of available tags see the Docker hub page for smtp4dev.

The folder /smtp4dev will be used for the database and auto-generated TLS certificate. You can mount a directory outside of the container here for peristent storage.

An example docker-compose.yml can be found here.

How to run smtp4dev as a Windows service

Download one the Windows standalone versions which is applicable for your OS/architecture.

Install service in PowerShell

New-Service -Name Smtp4dev -BinaryPathName "{PathToExe} --service"

Install service in Cmd or PowerShell

sc.exe create Smtp4dev binPath= "{PathToExe} --service"

How to run smtp4dev in Windows IIS

Make sure you have installed the ASP.NET Core Runtime - Windows Hosting Bundle so that IIS can host ASP.NET Core apps.

Also make sure the IIS application pre-initialisation feature is installed.

Download a smtp4dev release and unzip. You must pick the noruntime version.

Create a site in IIS and set the root path to where you unzipped smtp4dev (do not point at wwwroot or ClientApp). You can also host in a virtual directory under another site, but don't forget to convert the directory to an application.

Grant permission to the IIS app pool to read the files. The principal name is IIS APPPOOL\<name> where <name> is the name of the app pool, which is the name of the site you created unless you changed something.

Edit the application pool advanced settings and ensure:

  • '.NET CLR version' is set to 'No managed code'
  • 'Start Mode' is set to 'AlwaysRunning'
  • 'Idle Time-out (minutes)' is set to '0'
  • Recycling > 'Regular Time Interval (minutes)' is set to '0'
  • 'Preload enabled' is set to 'True'.

You can then access the site via the ports/hostname set in bindings that are set in IIS. If you see an error check the Application event log for details and you'll see any errors output from IIS.