Skip to main content
Version: 4.0 (2026 H1)

Update primedocs server

ℹ️ Info This page concerns the OnPremises option.
With the "Software as a Service" option, no server installations by the customer are necessary.

Before you start:

A prerequisite for updating the primedocs server is a complete primedocs installation (carried out as described here).

Updating​

The installation package contains a PowerShell script “Update.ps1”, which updates an existing installation. The script must be executed as administrator.

When updating, the new application files are copied via Robocopy, whereby existing configurations (web.config, nlog.config, primedocs.config and IIS configurations) are retained.

note

NOTE
The update script (“Update.ps1”) is designed for updating exactly one primedocs environment on a server. If several primedocs environments are found, If several primedocs environments are to run on the same server, the script must be called several times with the correct installation path.

Run Script​

The installation zip file must be unpacked beforehand.

The Update.ps1 is signed and can be called with the arguments. These are described in the file in a large comment (under “Usages”).

Standard call (for this, you must first navigate to the installation directory, e.g. with cd "C:\temp\primedocs_Install_Package") if primedocs has been installed under c:\inetpub\wwwroot\primedocs

.\Update.ps1

Further call options are described in “Update.ps1” under “Usages”.

Update via reinstallation​

To ensure that the IdentityServer signature (cert.pfx) and ASP.NET Core data protection keys are retained across new installations in fully automated primedocs deployments, and that existing OIDC sessions/tokens continue to be accepted, the following steps are necessary:

  1. Before reinstalling: Back up the relevant files/artifacts:

To prevent the files from being overwritten or deleted during a new installation, they should be stored outside the installation directory.

  • primedocs.config
  • cert.pfx (or existing signing certificate, if in the store)
  • Data-Protection Keys (key-*.xml)
  • nlog.config (if adjusted)
  1. Perform a new installation / run the installation script
  2. Restore backed-up files to their previous locations or import certificates into the store

Database Migrations​

After an update, the DataSourceAdminApp should be called to carry out any database migrations.