ScaleOut Product Suite Help
Installation

ScaleOut’s ASP.NET Session State Provider is installed by default with the product’s .NET API libraries, but your application will not use the provider until your web.config file is configured to use it. If you are running ASP.NET and you want ScaleOut StateServer to transparently save and retrieve ASP.NET session-state objects, please take the following additional steps:

The ScaleOut installation folder contains a sample ASP.NET Web site in the sub-folder \DOTNET4.0\SessionTest. This application lets you verify that your SOSS installation is working correctly. Please see the file SessionTest_readme.txt in this folder for more information.

	Tip
	The session provider has several parameters that can be used to configure its behavior. See the ASP.NET Session Provider Configuration Parameters topic for more information.

ScaleOut’s ASP.NET Output Cache Provider is installed by default with the product’s .NET API libraries, but your application will not use the provider until your web.config file is configured to use it. If you are running ASP.NET 4.0 (or higher) and you want ScaleOut StateServer to store output cache data, modify your application’s web.config file to add ScaleOut StateServer’s output cache provider. For example:

<caching>
  <outputCache defaultProvider="SossOutputCacheProvider">
    <providers>
      <add name="SossOutputCacheProvider"
           type="Soss.Web.SossOutputCacheProvider, soss_storeprovider, Version=5.0.0.0, Culture=neutral, PublicKeyToken=a1ec0b86f746a476"
           throwOnError="false"
           sossAccessTimeoutMilliseconds="250" />
    </providers>
  </outputCache>
</caching>

The output cache provider has a number of configuration parameters that can be used to adjust its behavior. See the ASP.NET Output Cache Provider Configuration Parameters topic for more information.

You optionally can install ScaleOut StateServer from the command line "quiet mode" with no user interaction by running the Windows utility program msiexec.exe from the command line with the /quiet switch. To install the 32-bit version of ScaleOut StateServer, run the following command:

msiexec.exe /i soss_setup32.msi /quiet

To install the x64 version of ScaleOut StateServer, run the following command:

msiexec.exe /i soss_setup64.msi /quiet

	Note
	When running an unattended installation on Windows Server 2008 or Windows Vista with UAC enabled, you must run the setup using the Administrator account. (It is not sufficient for your user to be part of the Administrators group if UAC is enabled.)

After installation, a pre-configured soss_params.txt file should be copied over the unconfigured one in the StateServer installation directory on each host. Restart the ScaleOut StateServer service ("soss.exe restart") for the new host configuration settings to take effect.

There are two approaches to specifying which product features are installed. You can either use the standard INSTALLLEVEL property to select an installation type, or you can specify the individual features that you’d like installed using the ADDLOCAL property. If you do not specify an INSTALLLEVEL or an ADDLOCAL property (see below) then a full server installation will be performed. Note that the INSTALLTYPE property that was used in earlier versions of the installer (prior to version 5.0) is no longer available.

Specifying an INSTALLLEVEL from the command line is equivalent to clicking one of the setup type buttons in the installer’s wizard UI (i.e., the "SOSS Full Install" and "Remote Client" buttons). For example, to install the remote client components you would run the following command:

msiexec.exe /i soss_setup64.msi /quiet INSTALLLEVEL=500

The INSTALLLEVEL values supported by the setup are defined as follows:

Individual features can be selected for installation from the command line using the ADDLOCAL property, where each feature is separated by a comma (and no spaces). This is equivalent to going into the installer’s wizard UI and clicking the Custom setup type button to select the desired features from a list. For example, to install just the management tools and the Java libraries, you would run the following command:

msiexec.exe /i soss_setup64.msi /quiet ADDLOCAL=ManagementTools,JavaLibs

The following feature identifiers are supported for the ADDLOCAL property:

To set the directory that the product will be installed in, use the APPLICATIONFOLDER property. So, for example, to perform a 32-bit remote client installation to the non-default "e:\SOSS" directory, you would run:

msiexec.exe /i soss_setup32.msi /quiet INSTALLLEVEL=500 APPLICATIONFOLDER="e:\SOSS"

Many additional properties are defined by Windows Installer. Consult the Microsoft Developer Network for a full list at http://msdn.microsoft.com/en-us/library/aa370905%28VS.85%29.aspx.

ScaleOut provides an implementation of Microsoft.Extensions.Caching.Distributed.IDistributedCache for caching and session state management in ASP.NET Core web applications. Unlike the provider for traditional ASP.NET applications, the ASP.NET Core version is an independent, standalone library that is distributed as a NuGet package; it does not require ScaleOut’s client libraries to be installed:

PM> Install-Package Scaleout.AspNetCore

"gateways": [
  {
    "ip": "10.0.0.100",
    "servicePort": 4001
  },
  {
    "ip": "10.0.0.101",
    "servicePort": 4001
  }
]