Contents

Configuration¶

logbee.Frontend functionality can be customized by updating the Configuration\logbee.json file.

A full example of the configuration file can be found on https://github.com/catalingavan/logbee-app/blob/main/logbee.Frontend/logbee.json.

LogbeeBackendConfigurationFilePath ¶

The path to the Logbee.Backend configuration file. The value can be absolute or relative.

{
    "LogbeeBackendConfigurationFilePath": "../../logbee.Backend/Configuration/logbee.json"
}

LogbeeFrontendDomain ¶

The domain of the Logbee.Frontend application. This value is used in multiple places:

when generating the HTML titles
sets the default email domain for the authenticated users (user@{LogbeeFrontendDomain}).
setting the sender email address to no-reply@ + LogbeeFrontendDomain (e.g., no-reply@logbee.dev), if no other value is specified under the Smtp.Sender configuration.

{
    "LogbeeFrontendDomain": "logbee.dev"
}

StaticResourcesVersion ¶

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.

{
    "StaticResourcesVersion": "1.0.0"
}

LogbeeFrontendUrl ¶

Root url pointing to Logbee.Frontend application.

{
    "LogbeeFrontendUrl": "http://logBee.myapp.com/"
}

LogbeeFrontend.BasicAuth.Password ¶

The Basic HTTP authentication scheme password used to connect to Logbee.Frontend application.

{
    "LogbeeFrontend.BasicAuth.Password": "_LogBeeFrontend_authorization_password_"
}

Logbee.License ¶

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

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

Database ¶

{
    "Database": {
        "Provider": "MongoDb",
        "MongoDb": {},
        "MySql": {},
        "SqlServer": {},
        "AzureCosmosDb": {}
    }
}

Database.Provider
MongoDb	Sets the database provider to MongoDb.
MySql	Sets the database provider to MySql.
SqlServer	Sets the database provider to MS-SQL.
AzureCosmosDb	Sets the database provider to Azure CosmosDB.

Database.MongoDb
Required when “Database.MongoDb” is “MongoDb”.

Database.MySql
Required when “Database.Provider” is “MySql”.

Database.SqlServer
Required when “Database.Provider” is “SqlServer”.

Database.AzureCosmosDb
Required when “Database.Provider” is “AzureCosmosDb”.

Database.MongoDb ¶

Configuration used to connect to MongoDb database.

{
    "Database": {
        "MongoDb": {
            "ConnectionString": "mongodb://localhost:27017?socketTimeoutMS=5000&connectTimeoutMS=5000",
            "DatabaseName": "LogbeeFrontend"
        }
    }
}

Database.MySql ¶

Configuration used to connect to MySql database.

{
    "Database": {
        "MySql": {
            "ConnectionString": "server=localhost;port=3306;database=LogbeeFrontend;uid=<replace_user>;password=<replace_password>;Charset=utf8;"
        }
    }
}

Database.SqlServer ¶

Configuration used to connect to MS-SQL database.

{
    "Database": {
        "SqlServer": {
            "ConnectionString": "Server=localhost;Database=LogbeeFrontend;User ID=<replace_user>;Password=<replace_password>;TrustServerCertificate=True;"
        }
    }
}

Database.AzureCosmosDb ¶

Configuration used to connect to Azure CosmosDB database.

{
    "Database": {
        "AzureCosmosDb": {
            "ApplicationRegion": "West Europe",
            "ConnectionString": "https://cosmos-db-name.documents.azure.com:443/;AccountKey=_accountKeyValue_;",
            "DatabaseName": "LogbeeFrontend",
            "AzureStorageAccountConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagename;AccountKey=_accountKeyValue_;EndpointSuffix=core.windows.net"
        }
    }
}

Smtp ¶

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

{
    "Smtp": {
        "Sender": {},
        "Host": "smtp.sendgrid.net",
        "Port": 587,
        "UserName": "",
        "Password": "",
        "EnableSsl": false
    }
}

Smtp.Sender ¶

The Smtp.Sender configuration is optional and allows for specifying the sender email address.

If not specified (null), the sender email address will default to no-reply@ + LogbeeFrontendDomain (e.g., no-reply@logbee.dev).

{
    "Smtp": {
        "Sender": {
            "Address": "no-reply@logbee.dev",
            "DisplayName": "Logbee"
        }
    }
}

Troubleshooting emails

Even if an email is successfully sent using the configured SMTP service, the delivery can be affected by several factors.

The reputation of the sender email address (e.g., no-reply@your-logbee-domain.com) plays a significant role in email delivery. Email providers may reject or flag emails from senders with poor reputations.

Recommendations:

Use a reputable SMTP service (e.g., SendGrid, Postmark).
Ensure your domain is authenticated to improve email delivery.
If you have an email address with a good reputation, you can use it under the Smtp.Sender.Address configuration.

Useful links:

How to Set Up Domain Authentication (SendGrid)
Checking your Sender Score - Sender Score gives you an idea of how email providers view your IP address, providing insights into how likely your emails are to reach inboxes.
Google Postmaster Tools - Google’s platform to help senders track email performance, including the reputation of your domain and delivery issues.
Google Header Analyzer - can be used to find out how long an email spent in a particular location.

UserInterface ¶

{
    "UserInterface": {
        "NumberOfApplicationsToPreloadOnTheDashboardPage": 6
    }
}

UserInterface.NumberOfApplicationsToPreloadOnTheDashboardPage
Specifies how many applications should be preloaded under the `/Dashboard` page.

Authorization ¶

{
    "Authorization": {
        "HS256Secret": "00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000",
        "AzureActiveDirectory": {}
    }
}

Authorization.HS256Secret
Represents the signature key of the authentication JSON Web Token (JWT). The authentication JWT must be signed with the secret provided in this property. More details about authentication can be found here.

Authorization.AzureActiveDirectory ¶

Optional configuration used to set up Azure Active Directory authentication.

More details about Azure Active Directory authentication can be found here.

{
    "Authorization": {
        "AzureActiveDirectory": {
            "ClientId": "<AD Application (client) ID>",
            "ClientSecret": "<secret>",
            "Authority": "https://login.microsoftonline.com/<AD Directory (tenant) ID>/v2.0/",
            "AuthorizedGroupIds": ["50679da3-74f4-4592-961c-9423257350dc"]
        }
    }
}

ApplicationSettings ¶

{
    "ApplicationSettings": {
        "CacheApplicationsRepositoryInSeconds": 600,
        "ProcessEmailsQueueIntervalInSeconds": 30,
        "DeleteProcessedEmails": {},
        "DeleteLocalLogFiles": {}
    }
}

ApplicationSettings.CacheApplicationsRepositoryInSeconds
Specifies the number of seconds for which the applications should be cached after they have been fetched from the database. This setting has no visible impact on the user interface but improves database performance, especially when using Azure CosmosDB. If the value is set to 0, caching will be disabled.

ApplicationSettings.ProcessEmailsQueueIntervalInSeconds
Defines the interval (in seconds) at which the system processes emails in the queue. A lower value increases responsiveness but may lead to more frequent database queries.

ApplicationSettings.DeleteProcessedEmails ¶

{
    "ApplicationSettings": {
        "DeleteProcessedEmails": {
            "SentMoreThanNHoursAgo": 12,
            "TriggerIntervalInMinutes": 60
        }
    }
}

DeleteProcessedEmails.SentMoreThanNHoursAgo
Specifies the number of hours after which sent and processed emails should be deleted. Helps prevent database bloat by automatically removing old emails.

DeleteProcessedEmails.TriggerIntervalInMinutes
Defines how often (in minutes) the system checks and removes processed emails that meet the criteria. A lower value ensures frequent cleanup but may increase database load.

ApplicationSettings.DeleteLocalLogFiles ¶

{
    "ApplicationSettings": {
        "DeleteLocalLogFiles": {
            "CreatedMoreThanNDaysAgo": 3,
            "TriggerIntervalInHours": 6
        }
    }
}

DeleteLocalLogFiles.CreatedMoreThanNDaysAgo
The number of days after which local log files should be deleted.

DeleteLocalLogFiles.TriggerIntervalInHours
The interval (in hours) at which the cleanup process runs.

For technical support, questions or any feedback, please feel free to send us a message and we will get back to you.