Getting Started

If you want to start using the standard Vonk server in your own Windows environment, follow the steps on this page to install and run the server.
For non Windows systems, or if you want to use Docker for Windows, please look at the Using Vonk on Docker section.

  1. Download the Vonk binaries and the license file from
  2. Extract the downloaded files to a location on your system, for example: C:\Vonk. We will call this the working directory.
  3. Put the license file in the working directory.
  4. In the working directory create a new JSON file and name it appsettings.json. You will use this file for settings that you want to differ from the defaults in appsettings.default.json. For more background on how the settings are processed, see Vonk settings

5. Open appsettings.json, copy the LicenseFile setting from appsettings.default.json to it and change this property to the name of your license file. For example

"License": {
    "LicenseFile": "vonk-trial-license.json"


The next step assumes you have a .Net Core environment installed. If not, please download and install ASP.NET Core Runtime 3.1.x before you continue. Choose the latest security patch to mitigate security issues in previous versions.

  1. Open a command prompt or Powershell, navigate to the working directory and run: > dotnet .\Vonk.Server.dll

    Vonk will then run on port 4080 of the system.

  2. If you want to check if Vonk is running correctly, open a browser and go to localhost:4080. You should see a homepage similar to this:


Please note that the third example query /Patient/example will only work if you first PUT a Patient with the id ‘example’. You can get this example from the specification.


The section Configuring the Vonk server explains how you can configure the Vonk server.

Running the server

When you have completed your configuration changes, you can run the server. Open a command prompt or Powershell, navigate to your working directory and run:

> dotnet .\Vonk.Server.dll