Skip to content

Configuration reference for the Print Agent

The background service reads its configuration from two sources (in this order; later ones do not win — environment variables take precedence):

  1. Environment variables with the DOCUFLAIR_ prefix; a double underscore separates the levels — PrintAgent:ServerUrl becomes DOCUFLAIR_PRINTAGENT__SERVERURL.
  2. appsettings.json / appsettings.Production.json next to the service binary, in the PrintAgent section.
{
"PrintAgent": {
"ServerUrl": "https://print.example.com",
"IgnoreServerCertificateErrors": false
}
}

All the keys live in the PrintAgent section:

Key Default Meaning
ServerUrl (empty) The Docuflair server address (https://…). It may stay empty — the status bar app passes the address at sign-in. If the value is empty, a default address built into the package (https://docuflair.imc.ac.at) applies as a last resort; for your own installations the address should therefore always be set explicitly or entered at sign-in.
InboxDirectory <data directory>/Inbox The folder watched for “Send to Docuflair”.
PayloadDirectory <data directory>/Payloads The cache for print data until it uploads.
DatabasePath <data directory>/queue.db The local job queue (SQLite).
PipeName docuflair-printagent The name of the local communication channel to the status bar app. If you change it, the same value has to be in tray-settings.json.
UploadPollInterval 00:00:05 The polling interval of the upload process.
LocalTcpListenerEnabled true Enable the local print data endpoint.
LocalTcpListenerPort 9100 The port of the endpoint on 127.0.0.1.
IgnoreServerCertificateErrors true Accepts server certificates that cannot be validated (self-signed ones). In environments with a trusted certificate, set it to false — see security and data protection.
ProxyUrl (empty) An explicit HTTP proxy, http://proxy.company.local:3128 for example. Empty = the system proxy or the HTTP(S)_PROXY environment variables.
ProxyUsername / ProxyPassword (empty) Credentials for the proxy (basic authentication only; stored in plain text).

The app stores its settings in tray-settings.json in the user profile: %LOCALAPPDATA%\Docuflair\PrintAgent (Windows), ~/Library/Application Support/Docuflair/PrintAgent (macOS), ~/.config/docuflair-printagent (Linux). Normally the values are maintained through the app’s settings dialog:

Key Meaning
serverUrl The server address (passed to the service at sign-in).
ignoreServerCertificateErrors The app’s certificate check (default true, as for the service).
language auto, de or en.
proxyUrl, proxyUsername, proxyPassword An explicit proxy; passed to the service at sign-in.
pipeName Change this only if the service uses a different PipeName too.
  • The service runs under a system account and does not see the user’s proxy settings. The typical symptom: the connection test in the app succeeds, but uploads stay stuck in Retrying. The remedy: enter the proxy in the app’s settings dialog (it is passed to the service), or configure PrintAgent:ProxyUrl for machines with no sign-in.
  • Only basic authentication is supported — NTLM and Kerberos proxies do not work.
  • The Microsoft sign-in always uses the system proxy, not the one configured explicitly.
  • If the proxy is removed, the service only picks that up after a restart of the service.
Variable Effect
DOCUFLAIR_PRINTAGENT__<KEY> Overrides any service key (see above).
DOCUFLAIR_PRINT_AGENT_PORT The target port of the CUPS backend (Linux/macOS), default 9100.
DOCUFLAIR_PRINTER_NAME The name of the print queue during package installation (Linux/macOS).
Operating system Service (queue, logs) Status bar app
Windows C:\ProgramData\Docuflair\PrintAgent %LOCALAPPDATA%\Docuflair\PrintAgent
Linux /var/spool/docuflair-printagent, logs in the journal ~/.config/docuflair-printagent
macOS /usr/local/var/docuflair-printagent, logs under /Library/Logs/Docuflair/PrintAgent ~/Library/Application Support/Docuflair/PrintAgent