Each DicomProxy instance is bound to a folder called ConfigRoot.
appsettings.json — default entries
{
// Default object with mandatory fields.
// If none exists, a default is saved and used on first run.
"AppSettings": {
// DicomProxy version this document is compatible with.
"Version": "1.0.0-1",
// Unique ID of this instance. Required when creating a mesh of instances
// and calling the central API. Auto-generated on first run.
"InstanceId": "00000000-0000-0000-0000-000000000000",
// Listening HTTP port
"HttpPort": 5100,
// HTTPS port
"HttpsPort": 5101,
// Serve static files. Dictionary<url, path>.
// url must not end in '/'. Actual mounted folder is Path.Combine(ConfigRoot, path).
"WwwRoots": {
"": "wwwroot", // root URL
"otherPath": "otherFolder"
},
// Default hostname for incoming requests and generated links
"Host": "localhost",
// Default AET of the running instance
"DicomAET": "DicomProxy1",
// DICOM SCP listening port (non-TLS)
"DicomPort": 31104,
// DICOM SCP listening port (TLS)
"DicomPortTLS": 31105,
// Default transfer syntax when serving DICOMweb/DIMSE requests and none other is specified
"DefaultTransferSyntax": "1.2.840.10008.1.2.1",
// Default folder for storing DICOM data.
// On first run, the local file system is selected as the default storage engine.
"StudiesRoot": "./data"
},
// Secondary switches
"ExtraConfig": {
// If true, the server does not check the Called AET against the running AET on new associations.
// Default: false
"Promiscuous": false,
// TUS Upload Folder — relative to ConfigRoot.
// Default: Path.Combine(ConfigRoot, "_tusuploads")
"TusUploadFolder": "_tusuploads",
// TUS upload endpoint
"TusUrlPath": "/tus",
// Scripts folder — relative to ConfigRoot.
// Default: Path.Combine(ConfigRoot, "scripts")
"ScriptsRoot": "scripts"
}
}
Next steps
- Lua API reference — scripting DicomProxy behaviour with Lua.
- DicomProxy overview — key features and use cases.