Table of Contents

MibCmsFrontEndServerBaseConfig

Introduction

This configuration is intended for the MibCmsFrontEndServerBaseConfig class, which manages front-end and middleware settings for the MIB CMS FrontEnd Server.

Keys - Default Section

rootUrl -> required
useFileManagementServiceForTsvDownload -> false
useMocks -> false
debugModeEnabled -> false
renderOnlyMibComponents -> false
defaultLanguage -> en-us
defaultSkin -> empty
startPage -> empty
DmmAssetImporterUrl -> empty
DmmAssetImporterUsername -> empty
DmmAssetImporterPassword -> empty
DmmWsUrl -> empty
DmmWsUsername -> empty
DmmWsPassword -> empty
googleAnalyticsTrackingId -> empty
tsvSlowExportLimit -> 3000
maximumCharacterLimit -> 100
advancedSearchHistoryMaxSize -> 10
logKestrel -> false
useOpenIdConnect -> false
requireHttpsOpenIdConnect -> true
deleteBatchSize -> 200
userConcurrencyServiceUrl -> empty
userConcurrencyPollingTime -> 00:00:10
userConcurrencyCachingDuration -> 12:00:00
enableUrlUpload -> true
useRandomBundleCacheKey -> false
ShowFullDebugPage -> false
corsHeaders -> *
corsMethods -> *
corsOrigins -> rootUrl
maxRequestBodySize -> 0
useEditHistoryMicroService -> false
enableAssemblyLoadingModeViaCustomFolder -> false
enableAssetLoadingViaCustomFolder -> false
customAssetContentPath -> empty
customAssetRequestPath -> empty
forceCacheControlOnStaticFiles -> false
whichFilesWillBeIgnoredByCacheControl -> empty
cacheControlMaxAge -> 31536000
LoadAllFieldsInMediaTypeIncludeCalls -> true
MaxFileSizeDefaultValue -> 1000000000
resizerUrl -> {imageUrl}
logo -> empty
colorPrimary -> green
colorSecondary -> empty
welcomeImage -> empty
cookieName -> empty
cookieExpireTimeSpan -> TimeSpan.MinValue
cookieSlidingExpiration -> true
frontendAppPath -> empty

Properties

RootUrl

Type: string
Description: Base URL for the application. Required. Throws exception if not set.
Default value:

UseFileManagementServiceForTsvDownload

Type: boolean
Description: Enables use of file management service for TSV downloads.
Default value: false

UseMocks

Type: boolean
Description: Enables mock data for testing.
Default value: false

DebugMessagesEnabled

Type: boolean
Description: Enables debug messages.
Default value: false

RenderOnlyMibComponents

Type: boolean
Description: Renders only MIB components.
Default value: false

DefaultLanguage

Type: string
Description: Default language.
Default value: en-us

DefaultSkin

Type: string
Description: Default UI skin.
Default value: empty

StartPage

Type: string
Description: Start page URL or route.
Default value: empty

DmmAssetImporterUrl, DmmAssetImporterUsername, DmmAssetImporterPassword

Type: string
Description: DMM asset importer integration settings.
Default value:

DmmWsUrl, DmmWsUsername, DmmWsPassword

Type: string
Description: DMM web service integration settings.
Default value:

GoogleAnalyticsTrackingId

Type: string
Description: Google Analytics tracking ID.
Default value: empty

TsvSlowExportLimit

Type: int
Description: Limit for slow TSV exports.
Default value: 3000

MaximumCharacterLimit

Type: int
Description: Maximum character limit for fields.
Default value: 100

AdvancedSearchHistoryMaxSize

Type: int
Description: Maximum size of advanced search history.
Default value: 10

LogKestrel

Type: boolean
Description: Enables Kestrel logging.
Default value: false

UseOpenIdConnect

Type: boolean
Description: Enables OpenID Connect authentication.
Default value: false

RequireHttpsOpenIdConnect

Type: boolean
Description: Requires HTTPS for OpenID Connect.
Default value: true

DeleteBatchSize

Type: int
Description: Batch size for delete operations.
Default value: 200

UserConcurrencyServiceUrl

Type: string
Description: URL for user concurrency service.
Default value: empty

UserConcurrencyPollingTime

Type: TimeSpan
Description: Polling interval for user concurrency.
Default value: 00:00:10

UserConcurrencyCachingDuration

Type: TimeSpan
Description: Caching duration for user concurrency.
Default value: 12:00:00

EnableUrlUpload

Type: boolean
Description: Enables upload via URL.
Default value: true

UseRandomBundleCacheKey

Type: boolean
Description: Uses random cache key for bundles.
Default value: false

ShowFullDebugPage

Type: boolean
Description: Shows full debug page.
Default value: false

CorsHeaders

Type: string
Description: CORS headers.
Default value: *

CorsMethods

Type: string
Description: CORS methods.
Default value: *

CorsOrigins

Type: string
Description: CORS origins.
Default value: rootUrl

MaxRequestBodySize

Type: long
Description: Maximum request body size.
Default value: 0

UseEditHistoryMicroService

Type: boolean
Description: Enables edit history microservice.
Default value: false

EnableAssemblyLoadingModeViaCustomFolder

Type: boolean
Description: Enables assembly loading from custom folder.
Default value: false

EnableAssetLoadingViaCustomFolder

Type: boolean
Description: Enables asset loading from custom folder.
Default value: false

CustomAssetContentPath

Type: string
Description: Path for custom asset content.
Default value: empty

CustomAssetRequestPath

Type: string
Description: Path for custom asset requests.
Default value: empty

ForceCacheControlOnStaticFiles

Type: boolean
Description: Forces cache control on static files.
Default value: false

WhichFilesWillBeIgnoredByCacheControl

Type: string[]
Description: Files ignored by cache control.
Default value: empty

CacheControlMaxAge

Type: int
Description: Max age for cache control (seconds).
Default value: 31536000

LoadAllFieldsInMediaTypeIncludeCalls

Type: boolean
Description: Loads all fields in media type include calls.
Default value: true

MaxFileSizeDefaultValue

Type: int
Description: Default max file size.
Default value: (see Constants.MaxFileSizeDefaultValue)

Type: string
Description: Logo image path or URL.
Default value: empty

ColorPrimary

Type: string
Description: Primary color.
Default value: green

ColorSecondary

Type: string
Description: Secondary color.
Default value: empty

WelcomeImage

Type: string
Description: Welcome image path or URL.
Default value: empty

CookieName

Type: string
Description: Cookie name.
Default value: empty

CookieExpireTimeSpan

Type: TimeSpan
Description: Cookie expiration timespan.
Default value: TimeSpan.MinValue

CookieSlidingExpiration

Type: boolean
Description: Enables sliding expiration for cookies.
Default value: true

FrontendAppPath

Type: string
Description: Path to the front-end app path. (e.g. /app)
Default value: empty
Example: Assuming that the CMS SPA is being served under https://samples.mediaibox.com.br/app, the value for this configuration should be /app.

Methods

UserConcurrencyServiceUrlHealth()

Returns the health check URL for the user concurrency service.

UserConcurrencyServiceUrlHealth(string excludeHealthCheck)

Returns the health check URL for the user concurrency service, excluding a specific health check.

CookieExpireTimeSpanDefined()

Returns true if CookieExpireTimeSpan is defined (not TimeSpan.MinValue).

GetImageFieldUrl(string imageUrl, string width = "", string height = "")

Returns a formatted image URL using the resizer URL pattern.

static GetSkins()

Returns all available skins from the configuration section "skins".

Example

MIBCMSFRONTENDSERVERBASECONFIG_ROOTURL=https://frontend.com 
MIBCMSFRONTENDSERVERBASECONFIG_DEFAULTLANGUAGE=pt-br 
MIBCMSFRONTENDSERVERBASECONFIG_DEFAULTSKIN=dark 
MIBCMSFRONTENDSERVERBASECONFIG_USEMOCKS=true 
MIBCMSFRONTENDSERVERBASECONFIG_ENABLEURLUPLOAD=false 
MIBCMSFRONTENDSERVERBASECONFIG_COOKIEEXPIRETIMESPAN=01:00:00 
MIBCMSFRONTENDSERVERBASECONFIG_CORSHEADERS=* 
MIBCMSFRONTENDSERVERBASECONFIG_CORSORIGINS=https://frontend.com

Who uses this configuration?

  • MibCmsFrontEndServer
  • Middleware and UI components in the MIB CMS platform
Edit this page