Developer Guide

Configuration

Full reference for appsettings.json configuration options.

Complete configuration example

{
  "ScreamReporting": {
    "LicenseKey": "SR-eyJ...",
    "ApplicationName": "YourApp",
    "DefaultLanguage": "en",
    "TrialDurationDays": 30,
    "AdminPath": "reportadmin",
    "AdminAuth": {
      "Enabled": true,
      "Username": "admin",
      "Password": "your-secure-password",
      "SessionTimeoutMinutes": 60,
      "ExternalAuthConfigured": false
    },
    "Pdf": {
      "BrowserExecutablePath": null,
      "DefaultOrientation": "Portrait",
      "TimeoutMs": 30000
    },
    "DigitalSignature": {
      "Enabled": false,
      "CertificatePath": null,
      "CertificatePassword": null,
      "Reason": "Digitally signed",
      "VisibleSignature": true,
      "SignaturePage": "Last"
    },
    "Scheduler": {
      "ConnectionString": null,
      "Smtp": {
        "Host": "smtp.gmail.com",
        "Port": 587,
        "UseSsl": true,
        "Username": "[email protected]",
        "Password": "your-password",
        "FromAddress": "[email protected]",
        "FromName": "Your Company Reports"
      }
    },
    "Audit": {
      "Enabled": true,
      "RetentionDays": 365
    }
  }
}

Options reference

Root options

Option	Type	Default	Description
`LicenseKey`	string	`""`	Your license key. Leave empty for Community or Trial.
`ApplicationName`	string	`"Application"`	Used in license binding and report headers.
`DefaultLanguage`	string	`"en"`	Default portal language.
`TrialDurationDays`	int	`30`	Trial duration in days.
`AdminPath`	string	`"reportadmin"`	URL path for the admin portal.

AdminAuth

Option	Type	Default	Description
`Enabled`	bool	`false`	Enable built-in username/password auth.
`Username`	string	`"admin"`	Admin username.
`Password`	string	`""`	Admin password.
`SessionTimeoutMinutes`	int	`60`	Session timeout in minutes.
`ExternalAuthConfigured`	bool	`false`	Set to `true` if using your own auth.

Pdf

Option	Type	Default	Description
`BrowserExecutablePath`	string	`null`	Custom path to Chromium executable.
`DefaultOrientation`	string	`"Portrait"`	Default page orientation.
`TimeoutMs`	int	`30000`	PDF generation timeout in milliseconds.

Audit

Option	Type	Default	Description
`Enabled`	bool	`true`	Enable audit trail.
`RetentionDays`	int	`365`	Days to keep audit entries.

Next: Authentication

← Quick Start Authentication →