Deploying as an IIS application

RavenDB can be run as an IIS application, or from a virtual directory under an IIS application.

Setting up a RavenDB IIS application

  1. Download the distribution zip, and extract the "Web" folder.
  2. In IIS Manager, create a new website and point it's physical path to the "/Web" folder you extracted. Alternatively, point a virtual directory under an existing website to that folder.
  3. Set the Application Pool for the IIS application you will be using to "ASP.Net v4.0", or create a new Application Pool set to .NET 4.0 Integrated Pipeline.
  4. Set port and host if needed.
  5. Make sure that the user you set for the website has write access to the physical database location.
  6. Make sure to disable "Overlapped Recycle" in App Pool Advanced Settings. (Otherwise, you may have two concurrent RavenDB instances competing for the same data directory, which is going to generate failures).

Setting up with IIS 7.5 and 8.0

  • Remove the WebDAVModule from the installed Modules on your IIS server
  • If you wish to run RavenDB with authentication:
    • Ensure that IIS "Windows Authentication" security module is installed (by default it is not). This can be checked under Programs and Features > Turn Windows features on or off > Internet Information Services > World Wide Web Services > Security.
    • Enable "Windows Authentication" for the RavenDB website.
    • In the web.config file, set the app settings value Raven/AnonymousUserAccessMode to Get or None
  • If you wish to run with no authentication:
    • In the web.config file, set the app settings value Raven/AnonymousUserAccessMode to All

Setting up with IIS 7

You may get a "405 Method Not Allowed" error when trying to create an index from the Client API when RavenDB is running in IIS 7.

This usually happens when you are running RavenDB from a virtual directory. The problem is a conflict that occurs with the WebDAV module. To resolve that, you need to edit the web.config file in the parent directory and add:

<system.webServer>
   <modules runAllManagedModulesForAllRequests="true">
      <remove name="WebDAVModule" />
   </modules>
 </system.webServer>

That will remove the WebDAV module and resolve the conflict.

Note

This modification is not to the RavenDB's web.config file, it is to the web.config of the parent application.

Setting up with IIS 6

When using IIS 6, you need to make sure all requests are mapped to the ASP.NET DLL, and modify the Web.config file and remove the system.webServer element and add the following system.web element:

<system.web>
   <httpHandlers>
      <add path="*" verb="*" 
         type="Raven.Web.ForwardToRavenRespondersFactory, Raven.Web"/>
   </httpHandlers>
</system.web>

If you are experiencing problems with accessing the Studio, try this step: Home Directory > Configuration > Wildcard application maps > Insert c:\windows\microsoft.net\framework\v4.0.30319\aspnet_isapi.dll, and Uncheck Verify file exists.

Web Configuration

Many configuration options are available for tuning RavenDB and fitting it to your needs. See the Configuration options page for complete info.

RavenDB isn't a typical web site because it needs to be running at all times. In IIS 7.5, you can set this using the following configuration settings:

  • If you created a dedicated application pool for RavenDB, change the application pool configuration in the application host file (C:\Windows\System32\inetsrv\config\applicationHost.config) to:

<add name="RavenApplicationPool" managedRuntimeVersion="v4.0" startMode="AlwaysRunning" />

  • If Raven runs in an application pool with other sites, modify the application host file (C:\Windows\System32\inetsrv\config\applicationHost.config) to:

<application path="/Raven" serviceAutoStartEnabled="true" />

HTTP Error 503

You may hit an HTTP Error 503 - "The service is unavailable" - when deploying to IIS, with nothing written to the Event Log.

This problem usually occurs when you are trying to run the RavenDB's IIS site on port 8080 after you have run RavenDB in executable mode. The problem stems from RavenDB reserving the http://+:8080/ namespace for your user, and when IIS attempts to start a site on the same endpoint, it errors.

You can resolve this problem by executing the following on the command line:

netsh http delete urlacl http://+:8080/

You can also see all existing registrations with the following command:

netsh http show urlacl

IISReset

Another issue that is worth mentioning is a IISReset problem. By default it gives the IIS server 20 seconds to restart, 60 seconds to stop and 0s to reboot, after that period of time it aborts the thread of the application by using Thread.Abort() (in context of a RavenDB it means that we will have to run recovery process next time we start, so it will take even longer). In most cases the amount of time might be enough, but when we consider a multi-tenancy feature and possibility of a database recovery process, then the given time might not be enough.

To handle the problematic IIS behavior we have redesigned the RavenDB startup process to handle Thread.Abort() more robustly and moved the DB initialization process to a separate, non-dependent by IIS process. More details about the issue and our solution can be found here.