If you want to start using the standard Firely 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 :ref:`use_docker` section.
- Download the Firely Server binaries and the license file from Simplifier.net.
- Extract the downloaded files to a location on your system, for example:
C:\FirelyServer
. We will call this the working directory. - Put the license file in the working directory.
- 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 inappsettings.default.json
. For more background on how the settings are processed, see :ref:`configure_appsettings`
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": "firelyserver-trial-license.json" }
The section :ref:`configure_vonk` explains how you can further configure the Firely Server.
Important
The next step assumes you have a .NET Core environment installed. If not, please download and install ASP.NET Core Runtime 6.x.xx Hosting Bundle before you continue. Choose the latest security patch to mitigate security issues in previous versions.
When you have completed your configuration changes, start the server. Open a command prompt or Powershell, navigate to your working directory and execute:
> dotnet .\Firely.Server.dll
Firely Server will by default run on port 4080 of the system. Check if Firely Server is running correctly, open a browser and navigate to localhost:4080
.
You will see the following homepage:
The following links provide documentation and samples for testing the Firely Server restful endpoint:
.. toctree:: :maxdepth: 1 :titlesonly: Postman Tutorial <../features/postman_tutorial> US Core & Postman Tests <../compliance/us_core>