https://github.com/suaveio/suave.iis
Set of helper functions for smooth running Suave.io web server on Internet Information Services (IIS)
https://github.com/suaveio/suave.iis
Last synced: 11 months ago
JSON representation
Set of helper functions for smooth running Suave.io web server on Internet Information Services (IIS)
- Host: GitHub
- URL: https://github.com/suaveio/suave.iis
- Owner: SuaveIO
- Created: 2016-11-21T12:14:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-07T11:51:40.000Z (almost 9 years ago)
- Last Synced: 2025-06-25T09:13:20.546Z (12 months ago)
- Language: F#
- Homepage:
- Size: 66.4 KB
- Stars: 8
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Suave IIS
Set of helper functions for smooth running [Suave.io](http://suave.io) web server on Internet Information Services (IIS) without common issues like problems with routing on sub-apps, etc...
## IIS Installation
### HttpPlatformHandler vs AspNetCoreModule
To host Suave.io web application, you need to use IIS module to redirect requests from IIS to your application. There are currently two modules:
* [HttpPlaformHandler](https://www.iis.net/downloads/microsoft/httpplatformhandler) - the "official and safe" module, however not updated for more than 2 years
* [AspNetCoreModule](https://github.com/aspnet/AspNetCoreModule) - fork of HttpPlatformHandler, [not supported as standalone component](https://github.com/aspnet/AspNetCoreModule/issues/117#issuecomment-311983265), but under active development with new features added
**Which one to use?**
Since Suave.IIS v2.3.0, you can use both, so it is up to you. If you can live without new features and want to something "100% production safe", then go for HttpPlatformHandler. If you rather want to live on the edge, go for AspNetCoreModule. I will do my best to keep support for both of them as long as possible.
## Web application installation
**Please note:** Currently **only Suave 2.x.x** version is supported. If you are running on older Suave, choose [Suave.IIS v1.0.0](https://www.nuget.org/packages/Suave.IIS/1.0.0).
Ok, we got IIS ready, now let`s install Nuget package:
Install-Package Suave.IIS
or using [Paket](http://fsprojects.github.io/Paket/getting-started.html)
nuget Suave.IIS
To start using IIS helpers in Suave, create own filter functions based on Suave.IIS.Filters & set port to configuration using `withPort` function.
```fsharp
[]
let main argv =
// use IIS related filter functions
let path st = Suave.IIS.Filters.path argv st
let pathScan format = Suave.IIS.Filters.pathScan argv format
let pathStarts st = Suave.IIS.Filters.pathStarts argv st
// routes
let webpart =
choose [
pathStarts "/st" >=> OK "Path starts with '/st'"
path "/test" >=> OK "Look ma! Routing on sub-app on localhost"
path "/" >=> OK "Hello from Suave on IIS"
]
// start service server
let config = { defaultConfig with bindings=[HttpBinding.create HTTP IPAddress.Any 8083us]; } |> Suave.IIS.Configuration.withPort argv
startWebServer config webpart
0
```
The last thing we need for proper run on IIS is `web.config`
**Using HttpPlatformHandler**
```xml
```
**Using AspNetCoreModule**
```xml
```
## IIS Application
Now create new web application on IIS:
Copy all your build files into `C:\inetpub\wwwroot\myiiswebname` and navigate to `http://localhost/myiiswebname`. You should see your web application output now.
## IIS Site
If you need to run Suave application as Site (on default port 80 or any other port), just **omit second parameter** in arguments attribute of httpPlatformHandler section in `web.config` file:
**Using HttpPlatformHandler**
```xml
```
**Using AspNetCoreModule**
```xml
```
## Suave.IIS on .NET Core
All the previous things are exactly the same (for both IIS Site & IIS Application), but there is little change in `web.config` file.
For IIS Site:
```xml
processPath="dotnet"
arguments="C:\inetpub\wwwroot\myiiswebname\myiiswebname.exe %ASPNETCORE_PORT%"
```
or IIS Application:
```xml
processPath="dotnet"
arguments="C:\inetpub\wwwroot\myiiswebname\myiiswebname.exe %ASPNETCORE_PORT% "myiiswebname""
```
## Good to know
1. Maybe you didn\`t notice, but using this library, you can still run Suave locally (from Visual Studio hitting F5 or FAKE script) - it there are no command line arguments, default setup is used, so you don\`t need to change anything. Just use `withPort` and create custom filter functions based on `Suave.IIS.Configuration`.
2. Only few (three, actually :)) filter functions are wrapped in `Suave.IIS.Filters`. If you need more of them, please feel free to send PR.