Skip to content

Configuration Settings

All configuation settings of this software are stored in the file AppSettings.json. This document describes where to find it, what you can edit and what valid settings are.

Location

The AppSettings.json file located at;

  • Windows: C:\Users\<username>\AppData\Local\SDH Software\PTP
  • MacOS: ~/.local/share/SDH Software/PTP
  • Linux: ~/.local/share/SDH Software/PTP

Default layout

By default the AppSettings.json file looks like this:

{
  "AllowedHosts": "*",
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "http://127.0.0.1:5000"
      }
    }
  },
  "Database": {
    "Driver": "",
    "ConnectionString": ""
  },
  "Culture": {
    "Language": "nl-NL",
    "WeekFormat": "ISO"
  },
  "Company": {
    "Name": "My company",
    "ScheduleHoursDay": 8,
    "ActiveModules": "None"
  },
  "Serilog": {
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    }
  },
  "DetailedErrors": false
}

Hosting Settings

This only applies to the server version - The hosing settings are stored in the Kestrel section. The URL defines on which adres the software will be hosted on the server. By default is based on the HTTP protocol, but technically you could place a load balancer or proxy before it.

If anything goes wrong with the hosting than you will see error messages on startup. See also the Error Messages topic for more information.

Database Settings

This only applies to the server version - The database settings are stored in the Database. Inside this section the Driver controls which database driver is used and the ConnectionString holds the connection string to the database.

There are 2 database driver supported; SQLITE and SQLSERVER. By default SQLITE is used.

If you preffer to use a SQL Server instead then the configuration would look something like this;

"Database": {
  "Driver": "SQLSERVER",
  "ConnectionString": "Server=localhost;Database=Planner;Integrated Security=True;TrustServerCertificate=True"
}

If anything goes wrong with the database connection than you will see error messages on startup. See also the Error Messages topic for more information.

Culture Settings

The culture settings (language, weekdefinition) and the company settings are controlled from within the software.

Logging

The sections Serilog and DetailedErrors are to control what sort of log messages are produced by the software. In general you do not have to touch these settings.