Installation
The server ships as a self-contained package: no separate .NET installation is required; text recognition (including language models), the document engine, the database and the search index are all included. Users then work through the browser without installing anything.
Windows
Section titled “Windows”Setup file: DocuflairCoreSetup-<version>.exe (requires administrator rights, 64-bit, Windows 10 / Windows Server 2016 or later).
The wizard asks for two things:
- Data directory — default
C:\Program Files\Docuflair\core\data; it holds the system database, tenant databases, document storage, search index and log files, and is the basis for your backup - Network — HTTP port (default 5050), optionally HTTPS (default port 5001) with a PFX/P12 certificate and password
The installer then sets up the following automatically:
- program files under
C:\Program Files\Docuflair\core - the Windows service “Docuflair Core Service” (service name
DocuflairCore, automatic startup) and starts it - Windows Firewall rules for the selected ports
- the production configuration
appsettings.Production.json— including a randomly generated JWT signing key and file logging to<data directory>\logs\(daily rotation, 30 files)
Updating: simply run the newer setup. The installer detects the existing installation, stops the service, replaces the program files and starts it again — production configuration, ports and data directory remain unchanged.
On Linux, deployment happens over SSH (the vendor supplies the details and scripts with delivery):
- installation to
/opt/velkariswith a dedicated service account that has no login shell - systemd service
velkaris.service(Restart=always, production environment), managed viasystemctl status|restart velkaris - the data directory
/opt/velkaris/datasurvives updates; everything else is replaced — so keep your own changes in a systemd drop-in or in environment variables, not inappsettings.json - behind a reverse proxy, announce the proxy address via
Velkaris__ForwardedHeaders__KnownProxies__0
First sign-in
Section titled “First sign-in”- Open the web interface at
http://<server>:5050. - Sign in with the tenant code
systemand the initial credentials from your delivery — the system immediately forces you to change the default password. - Complete the initial configuration (see Operation and security): enable encryption for the document storage, and set up HTTPS or a reverse proxy.
- Create your first tenant and apply a licence. Note for the tenant administrator that is created automatically: change the default password manually, right away — the system does not force the change here.
Verifying the installation
Section titled “Verifying the installation”- Signing in to the web interface works.
- The dashboard shows the background worker as Active (“Last tick” a few seconds old).
- For external monitoring,
GET /api/system/healthreturns the same metrics.
