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 \bin subdirectory under the working directory.

  4. Open \bin\appsettings.json and change the LicenseFile property to the name of your license file. For example:

    "LicenseFile": "vonk-trial-license.json",


the next step assumes you have a .Net Core environment installed. If not, please download and install it before you continue.

  1. Open a command prompt or Powershell, navigate to the bin 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 next section explains how you can configure the Vonk server.