Installation

The ScaleOut Active Caching service provides web-based UI that allows you to deploy and manage modules. In this topic, you will learn how to enable and configure it.

Prerequisites

  • A ScaleOut StateServer cluster on your network, accessible from the server you will use for this installation.

  • A license key for ScaleOut Active Caching that has been entered into the ScaleOut StateServer Management Console (contact sales@scaleoutsoftware.com to obtain a license key).

Important

The ScaleOut StateServer cluster must be active with at least one host joined to form an in-memory data grid. (A joined host has a green icon in the ScaleOut Management Console.)

Deployment Overview

This quickstart guide explains how to run the service on an single ScaleOut StateServer host machine, as it requires minimal additional configuration. In this approach, the ScaleOut Active Caching service only needs to be started on one host in your ScaleOut StateServer cluster. By default, the service uses a self-signed certificate and is only accessible locally through the ‘localhost’ DNS name. A SQLite database on the local filesystem is used for storage.

To run the ScaleOut Active Caching service on a multiple machines across a ScaleOut cluster, please refer to the Installation and Configuration topic for more details.

Start the ScaleOut Active Caching Service

By default, ScaleOut Active Caching services are installed by the ScaleOut Product Suite installer, but not started. Once the ScaleOut Product Suite is installed and at least one host has joined the ScaleOut StateServer cluster, start the ScaleOut Active Caching service:

From an elevated command prompt, run:

net start soss-ac-web

To enable the ScaleOut Active Caching service to start automatically on system boot, run the following command:

From an elevated command prompt, run:

sc config soss-ac-web start=auto

Install the Provided Self-Signed Certificate

For convenience, the ScaleOut Active Caching service pre-installs a self-signed TLS certificate. This self-signed certificate is not intended for production usage and should be replaced with a trusted certificate. Follow our step-by-step guide to use your trusted certificate within your domain.

The provided self-signed certificate is located in the installation folder:

C:\Program Files\ScaleOut_Software\StateServer\ActiveCachingWebUI\WebService.Api\certs

  • Right-click on the public key certificate file (default-sossac-cert.crt) and choose Install Certificate. The Certificate Import Wizard will appear.

  • Select the Local Machine store location and click Next.

  • Select Place all certificates in the following store and click on Browse.

  • Select the Trusted Root Certification Authorities store and click Ok.

  • Click Next and then Finish to complete the installation of the public key certificate.

While these instructions work for Google Chrome, they might not be sufficient for Mozilla Firefox. If you still see Not Secure in the address bar after following these steps and restarting Firefox, you might need to add a certificate exception as described in the corresponding Linux instructions.

In Mozilla Firefox, add a certificate exception by:

  1. Navigating to Settings (alternatively, type about:preferences into the search bar).

  2. Click Privacy and Security.

  3. Scroll down to the Certificates section and select View Certificates.

  4. Click Servers

  5. Click Add Exception

  6. For location, enter one of the service URLs – i.e. https://localhost:7701.

  7. Click Get Certificate.

  8. Click Confirm Security Exception.

  9. Repeat for all service URLs.

Open the ScaleOut Active Caching Management UI

Note

Install the self-signed certificate before opening the ScaleOut Active Caching Management UI.

On the computer where you completed the installation, open https://localhost:7701 in a web browser to access the ScaleOut Active Caching Management UI.

UI_01

Press Login to authenticate.

UI_02

On that page, use the built-in Administrator account:

  • Email: admin@localhost.net

  • Password: Sc@le0ut

To register new users or manage passwords and membership roles, please refer to the Manage Users page.

Once authenticated, you will land on the home page of the ScaleOut Active Caching Management UI.

UI_05

The ScaleOut Active Caching Management UI allows you to add and manage modules, add connections to external messaging services (such as Azure IoT Hub or Kafka), and add connections to persistence services (such as Dynamo DB, SQL Server, or Cosmos DB).

You will also be able to create and run queries and charts for your modules and track usage statistics.

You are now ready to build your first module.