Webserver Configuration

The Webserver has a minimal JSON configuration file for service-level settings, while most operational settings are managed through the Web UI and stored in its embedded key-value database.

Service Configuration (webserver.json)

This file must be in the same directory as the executable.

{
  "HTTPS": "true",
  "PortAPI": "8050",
  "PortWEB": "9090",
  "RunUser": "mugnsoft",
  "_sharedInternal": "<same-value-on-every-component>"
}

PDF reports (PdfBrowser)

Since 4.3.0 a report can be emailed as a PDF (see Language and format). The Webserver still builds the HTML report, then starts a headless Chrome, Chromium or Edge that opens it, waits for the charts to be drawn and prints it to A4 landscape. Nothing else needs to be installed: the browser is driven directly, without a driver.

Which browser is used. When PdfBrowser is set, that executable and no other. A path that does not exist is not replaced by another browser: the report falls back to HTML with the error PdfBrowser "<path>" in webserver.json does not exist. When PdfBrowser is empty or absent, the Webserver looks for:

Windows 10/11 and Windows Server 2022 or later ship with Edge, so PDF works there without any setting. On Linux, install a browser, for example:

# Debian / Ubuntu
sudo apt install chromium
# RHEL / Rocky / Alma (EPEL)
sudo dnf install chromium

Set PdfBrowser when the browser is elsewhere, or to pin one browser when several are installed:

{
  "HTTPS": "true",
  "PortAPI": "8050",
  "PortWEB": "9090",
  "RunUser": "mugnsoft",
  "_sharedInternal": "<same-value-on-every-component>",
  "PdfBrowser": "/opt/google/chrome/chrome"
}

On Windows, escape the backslashes: "PdfBrowser": "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe". The setting is read at start-up, so restart the Webserver after changing it.

How it runs.

• Each print uses a throwaway browser profile, deleted afterwards. Your browser profiles, cookies and extensions are never read.
• Running as root (typical in a container), the browser is started with --no-sandbox, because Chrome refuses its sandbox as root. Run the service as a regular user (RunUser) to keep the sandbox.
• At most two reports are printed at the same time; the others wait their turn. Allow 150–300 MB of memory per print.
• A print that does not finish in time (60 s for the charts to be drawn, 2 minutes in all) is abandoned, and the report is sent as HTML.
• No Internet access is needed. The report page asks for its libraries (Chart.js, UIkit, jQuery, moment…) from public CDNs; while printing, the Webserver answers those requests itself from the copies built into it, and refuses any other request. A Webserver on a closed network prints complete PDFs. For HTML reports read without Internet access, see Reports without Internet access.
• A page whose chart library did not load is not printed as empty panels: the report is sent as HTML with the reason the report libraries did not load.

Docker. The mugnsoft/webserver image does not include a browser, so PDF reports fall back to HTML. To print PDFs, build an image from it that adds Chromium, and set PdfBrowser if it is not in one of the locations above.

Troubleshooting. When the PDF is missing, the send result shows PDF unavailable (reason) and the Webserver log has a sendReportEmail ... PDF not produced line with the cause:

Runtime Settings (via Web UI)

These settings are configured through the Settings page in the Web UI and stored encrypted in the embedded key-value store.

SMTP (Email)

Slack Integration

GitLab Integration

LDAP Integration

Logging

JWT Authentication Settings

These are compiled into the binary and cannot be changed via configuration:

File Locations

Translations

• fr: Configuration du Webserver