Common configuration

ImageVault.Common is a library used on both server and client side of an ImageVault application. The common library exposes some configuration options.

{
  "ImageVault": {
    "Common": {
      "ObjectCache": {
        "DefaultProvider": "RedisObjectCache",
        "Providers": [
          {
            "Name": "RedisObjectCache",
            "Type": "ImageVault.Core.Platform.RedisObjectCache, ImageVault.Core.Platform"
          }
        ],
        "MicroCache": {
          "Enabled": false,
          "CacheDuration": 20,
          "CleanupThreshold": 20000
        }
      },
      "ApplicationInsightsDeveloperMode": true,
      "ApplicationInsightsDisabled": true,
      "ApplicationInsightsEnableProfiling": true,
      "LegacyUsernameIsValidIdentifier": false,
      "AuthSameSiteCookieMode": "lax",
      "IdentityPrefix": "test",
      "MediaRendererResourceServiceUrl": "https://myCustomUrl.com/path/",
      "SecurityProtocolType": 3264,
      "EnableDebugLogging": false,
      "IdentityHandlerAuthKey": "secretpassword",
      "DefaultMediaFormatOutputType": "WebSafeWebP"
    }
  }
}

ObjectCache

Primarily used to configure the [IObjectCache][].

Providers

Contains a list of Providers available to the object cache. Each provider is defined by a Name and a Type where the Type is the Assembly qualified name to the [IObjectCache][] implementation.

Default provider

The name of the provider used as default whenever an [IObjectCache][] is requested.

MicroCache

Configuration for the MicroCache feature.

Enabled

true by default. If set to false, the MicroCache feature is disabled

CacheDuration

The number of seconds that the cache should be valid, defaults to 10 sec.

CleanupThreshold

The threshold limit when the items should be cleared, defaults to 10000 items.

ApplicationInsightsDeveloperMode

When using AI, entries are buffered and not sent immediately to the AI instance (once per minute). If developer mode is activated, entries are sent immediately. This can reduce performance in production.

ApplicationInsightsDisabled

Application insights is enabled if you enter an Application Insights connection string. If you would like to disable it without clearing the Application Insights connection string, set the disabled value to true.

ApplicationInsightsEnableProfiling

Enables profiling for ImageVault and sends detailed profiling data to AI.

LegacyUsernameIsValidIdentifier

In ImageVault 4, the name of the user was a valid identifier and was registered in the database. In ImageVault 5 every user is identified by its user id (which is a guid). If you have an upgraded installation, you might want to activate this until you have fixed all user rights that was created using the username. Set this to true to include the username as an identifier as per ImageVault 4.

AuthSameSiteCookieMode

Override default value for same site configuration. Can be blank, "lax", "strict" or "none". Default is blank.

IdentityPrefix

If you have multiple ImageVaults that uses different user catalogs you can set the identity prefix to a value that will be prefixed all user and group identities to guarantee uniqueness between users and groups. You configure the identity prefix in the ImageVault UI application and NOT on the client.

MediaRendererResourceServiceUrl

The media renderer relies on resource files, like scripts and stylesheets. These are normally bundled with the ImageVault service and the default value of this property is "/". If you would like the resources to be loaded from another source, you can specify this source here.

SecurityProtocolType

When ImageVault communicates with an external service using SSL, this configuration can set the security protocol type that we allow. As default we allow SSL3.0, TLS 1.0 and TLS 1.2. To change this, set this configuration to a value that combines all numerical values of the protocols that you would like to allow. The following table shows the different values

Protocol	Value
[SSL 2.0][]	12
[SSL 3.0][]	48
[TLS 1.0][]	192
[TLS 1.1][]	768
[TLS 1.2][]	3072

As default, we use the value 3312 that enables SSL 3.0, TLS 1.0 and TLS 1.2

See more information about security protocol type at the MSDN page https://msdn.microsoft.com/en-us/library/system.net.securityprotocoltype

EnableDebugLogging

Toggles if internal debug logging should be enabled or not. Default is true.

IdentityHandlerAuthKey

Defines the auth key used for the ConfigFileAuthKeyReader

DefaultMediaFormatOutputType

Note

Added in ImageVault.Common v6.1) As default, reqeusted assets are retrieved using the [MediaOutputFormatType.WebSafe][] output type unless specified on the requested format. This option is used to configure the default output type without having to change any code when retrieving assets. For instance, if you would like to utilize the webp format, set this to use the [MediaOutputFormatType.WebSafeWebP][] format as default.