Configuration Files in Checkbox Version 8

Checkbox Version 8 introduced a modernised configuration structure.

Each application component, the Web App, API, and Services, has its own configuration file.

These files store environment-specific settings such as database details, base URLs, and logging paths.

This article outlines the key configuration files used in Checkbox v8 and when you may need to share them with Checkbox Support.

1. Web Application Configuration (web.config)

Location:

C:\\inetpub\\wwwroot\\CheckboxWeb\\

Purpose:

• Defines the web application’s connection to the database and API.
• Stores feature flags and general app behavior settings.

Example:

<connectionStrings>
  <add name="DefaultConnection" connectionString="Data Source=SQLSERVER;Initial Catalog=CheckboxDB;User ID=checkbox;Password=******" />
</connectionStrings>

<appSettings>
  <add key="BaseApiUrl" value="<https://checkbox-api.company.com/>" />
  <add key="AllowReportDelivery" value="true" />
</appSettings>

Used by:

• Checkbox Web UI (admin and respondent portals)

2. API Configuration (web.config)

Location:

C:\\inetpub\\wwwroot\\CheckboxApi\\

Purpose:

• Defines backend API behavior, including:
  • Database connection strings
  • CORS policy
  • JWT secret keys and security tokens

Used by:

• The Checkbox REST API, which serves as the bridge between the web UI and database.

3. Service Configuration (app.config)

Location:

C:\\Program Files\\Checkbox\\Services\\CheckboxBackgroundService\\

(or similar service directories)

Purpose:

• Contains configuration for background processes such as:
  • Scheduled reports
  • Notification delivery
  • Maintenance jobs

Example:

<appSettings>
  <add key="ServiceIntervalMinutes" value="10" />
  <add key="ApiUrl" value="<https://checkbox-api.company.com/>" />
</appSettings>

Used by:

• Checkbox Background and Report Services.

4. Optional Logging Configuration (appsettings.json)

Purpose:

• Some builds of v8 include a JSON file for logging configuration (via Serilog).

Example:

{
  "Serilog": {
    "WriteTo": { "File": { "path": "C:\\\\Logs\\\\checkbox.log" } }
  }
}

🧭 Summary Table

📤 When to Share Config Files with Support

Below is the summary of when you will be required to share the config files with Checkbox support.

🛡️ Security Reminder

Before sending configuration files to Checkbox Support, make sure to remove or mask passwords, APIs and secrets.