Getting Started
Hosted Instance
A hosted instance of this server is available at https://udap-security.fast.hl7.org.
This guide is for running the server locally for development or testing purposes.
Requirements
To run the server locally, you will need:
- .NET 9 SDK - Required
- Microsoft SQL Server - Optional (SQLite is used by default)
- Python 3.x - Optional (for building documentation)
Starting the Server Locally
Run the server from the root directory of the project:
Server Started
The server will start on https://localhost:5001 by default.
Development Certificates
First Time Setup
If this is your first time running the server, you'll likely need to create and trust a development certificate.
Create the certificate:
Trust the certificate:
Learn More
For more information on development certificates, see the .NET documentation.
Running in a Container
You can also run the server in a container.
Container Manager Compatibility
These instructions use Docker, but should work with other OCI-compatible container managers like Podman.
The easiest way to run the server is using Docker Compose:
This will use the pre-built image from Docker Hub and start the server with all necessary configuration.