1. Documentation
  2. KissLog on-premises
  3. KissLog.Frontend

KissLog.Frontend

Configuration

KissLog.Frontend configuration is achieved by updating the KissLog.Frontend\Configuration\KissLog.json.

ApplicationName

Display name of the on-premises KissLog application - used when generating HTML titles.

{
    "ApplicationName": "My logging app"
}

AppVersion

Property used as query string parameter when loading static resources (css/javascript).

This property should be changed after an application update in order to invalidate the static files cache.

{
    "AppVersion": "1.0.0"
}

InternalLogs.DirectoryPath

Specifies the location of the internal logs folder. Path can be either relative or absolute.

{
    "InternalLogs.DirectoryPath": "Logs"
}

InternalLogs.MinimumStatusCode

Specifies the minimum http status code for the requests which should be saved to internal logs.

{
    "InternalLogs.MinimumStatusCode": "400"
}

KissLogBackend.BasicAuth.Password

The Basic HTTP authentication scheme password used to connect to KissLog.Backend application.

This property should have the same value as the same property from KissLog.Backend\Configuration\KissLog.json.

{
    "KissLogBackend.BasicAuth.Password": "_This_Password_Should_Be_Replaced_"
}

KissLog.License

The KissLog on-premises license key. Can be null.

{
    "KissLog.License": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJMaWNlbnNlSWQiOiIzNTczMDI1My00NGRhLTRiZmMtOGQ0MS1iMzUzMDRkZWUyMzciLCJMaWNlbnNlVHlwZSI6IkVudGVycHJpc2UifQ.K4htH3YOulrpVrkTJuHza81VrYloYvTsfRYzb4fpUYI"
}

KissLogBackendUrl

Root url pointing to KissLog.Backend application.

{
    "KissLogBackendUrl": "http://kisslog-backend.myapp.com/"
}

KissLogFrontendUrl

Root url pointing to KissLog.Frontend application.

{
    "KissLogFrontendUrl": "http://kisslog.myapp.com/"
}

MediaDirectoryPath

Specifies the location of the media files uploaded within the application. Path can be either relative or absolute.

{
    "MediaDirectoryPath": ""
}

Database

{
    "Database": {
        "Provider": "SqlServer",
        "KissLogDbContext": "Data Source=192.168.16.11;Initial Catalog=KissLog;UID=user;PWD=pass;"
    }
}

Database.Provider

"SqlServer"

Sets the database provider to MS-SQL

"MySql"

Sets the database provider to MySql

Database.KissLogDbContext

Database connection string

Example

Database.Provider = "SqlServer"

“Data Source=192.168.16.11;Initial Catalog=KissLog;UID=user;PWD=pass;”

Database.Provider = "MySql"

“server=192.168.16.11;port=3306;database=KissLog;uid=root;password=pass;Charset=utf8;”

Authorization

{
    "Authorization": {
        "DefaultEmailDomain": "myapp.com",
        "HS256Secret": "J6UVNS3EKG46O1S1OVJ59OZ8DH3KEP",
        "SessionCookie": { },
        "ExternalIdentityProviders": { }
    }
}

Authorization.DefaultEmailDomain

Sets the default email domain for the authenticated users.

For example, darcy user will be displayed in the user-interface as darcy@myapp.com.

Authorization.HS256Secret

Represents the authentication JWT signature key.

In order to authenticate to this KissLog application, the user must provide a JWT token which has been signed with the same key (HS256Secret) that has been specified here.

The authentication JWT can be created programmatically or online using https://jwt.io/.

SessionCookie

{
    "Authorization": {
        "SessionCookie": {
            "IsPersistentFixedValue": null,
            "ExpireInMinutes": 10080
        }
    }
}

SessionCookie.IsPersistentFixedValue

null

Allows the user to specify, at login page, if he/she wants to create a persistent cookie or not.

true

Authentication will create a peristent cookie.

The user will be remembered after he/she closes the browser.

false

Authentication will create a session cookie.

The user will need to sign in again after he/she closes the browser.

SessionCookie.ExpireInMinutes

Specifies the persistent cookie expiration time.

ExternalIdentityProviders

Configuration for external identity providers authentication.

{
    "Authorization": {
        "ExternalIdentityProviders": {
            "AzureActiveDirectory": { }
        }
    }
}
AzureActiveDirectory

Configuration options for Azure ActiveDirectory authentication option.

{
    "Authorization": {
        "ExternalIdentityProviders": {
            "AzureActiveDirectory": {
                "ClientId": "eb042044-cb75-49a3-a73d-493250cf0017",
                "ClientSecret": "sM95AEDVJwh28qYRJWkyWCvFUYHAnPYHmC",
                "Authority": "https://login.microsoftonline.com/299de8ce-0c07-49d3-bea7-3b8b8bd3d2c9/v2.0/"
            }
        }
    }
}

Smtp

SMTP configuration used for sending automated emails (alert notifications).

{
    "Smtp": {
        "Host": "smtp.sendgrid.net",
        "Port": 587,
        "UserName": "",
        "Password": "",
        "EnableSsl": false,
        "From": {
            "Address": "support@kisslog.net",
            "DisplayName": "KissLog"
        }
    }
}

UserInterface

{
    "UserInterface": {
        "ForceAvatarSrc": null,
        "CreatePermalinkWithAnonymousAccess": { },
        "Applications": { },
        "Dashboard": { }
    }
}

UserInterface.ForceAvatarSrc

When a value is provided, the user avatars (displayed in the user-interface) will always use this value.

This is useful when you need to prevent any external resources loading.

null

User avatars will be generated using Gravatar (default).

string

User avatars will always load the provided src value.

Example: "ForceAvatarSrc": "/images/defaultAvatar.png"

CreatePermalinkWithAnonymousAccess

{
    "UserInterface": {
        "CreatePermalinkWithAnonymousAccess": {
            "IsEnabled": true,
            "ValidForSeconds": 7200
        }
    }
}

CreatePermalinkWithAnonymousAccess.IsEnabled

true

Permalinks created from the user interface (links to request logs) can be anonymously accessed for a limited period of time.

false

Permalinks created from the user interface can be accessed only by authenticated users.

CreatePermalinkWithAnonymousAccess.ValidForSeconds

Required when CreatePermalinkWithAnonymousAccess.IsEnabled = true

Specifies for how long after creation the permalink can be anonymously accessed.

Applications

{
    "UserInterface": {
        "Applications": {
            "LoadHowMany": 6
        }
    }
}

Applications.LoadHowMany

Specifies how many applications should be preloaded under the /Applications section.

Dashboard

{
    "UserInterface": {
        "Dashboard": {
            "ShowReferringSites": true
        }
    }
}

ShowReferringSites

true

The list of individual referring sites will be visible under the Dashboard page.

false

The list of individual referring sites will not be visible under the Dashboard page.