-
Notifications
You must be signed in to change notification settings - Fork 1
PlantUML Server Configuration
By default, diagrams are rendered via the public PlantUML server at https://plantuml.com/plantuml. To use a private/self-hosted server, set PlantUmlServerBaseUrl in either ReportConfigurationOptions or DiagramsFetcherOptions:
new ReportConfigurationOptions
{
PlantUmlServerBaseUrl = "https://plantuml.mycompany.com/plantuml"
}The library appends /{format}/{encoded} to this base URL to generate image source URLs, where {format} is determined by PlantUmlImageFormat (png by default).
By default, diagrams are rendered as PNG images. To use SVG instead, set PlantUmlImageFormat:
new ReportConfigurationOptions
{
PlantUmlImageFormat = PlantUmlImageFormat.Svg
}This changes the URL path from /png/{encoded} to /svg/{encoded}. SVG diagrams are resolution-independent and produce sharper output at any zoom level, but may render differently depending on the PlantUML server version.
To render diagrams locally without any remote server dependency, install the Kronikol.PlantUml.Ikvm package. This uses IKVM to run the PlantUML Java library directly in .NET.
See Integration PlantUML IKVM for full setup instructions.
Getting Started
Common Tasks
Integration Guides
- Integration xUnit3
- Integration xUnit2
- Integration NUnit
- Integration MSTest
- Integration TUnit
- Integration BDDfy xUnit3
- Integration LightBDD xUnit2
- Integration LightBDD xUnit3
- Integration LightBDD TUnit
- Integration ReqNRoll xUnit2
- Integration ReqNRoll xUnit3
- Integration ReqNRoll TUnit
Extensions
- Integration AtlasDataApi Extension
- Integration BigQuery Extension
- Integration Bigtable Extension
- Integration BlobStorage Extension
- Integration CloudStorage Extension
- Integration CosmosDB Extension
- Integration Dapper Extension
- Integration DynamoDB Extension
- Integration EF Core Relational Extension
- Integration Elasticsearch Extension
- Integration EventBridge Extension
- Integration EventHubs Extension
- Integration Grpc Extension
- Integration Kafka Extension
- Integration MassTransit Extension
- Integration MongoDB Extension
- Integration MySqlConnector Extension
- Integration Npgsql Extension
- Integration Oracle Extension
- Integration PubSub Extension
- Integration Redis Extension
- Integration S3 Extension
- Integration ServiceBus Extension
- Integration SNS Extension
- Integration Spanner Extension
- Integration SqlClient Extension
- Integration Sqlite Extension
- Integration SQS Extension
- Integration StorageQueues Extension
- Integration OpenTelemetry Extension
- Integration DispatchProxy Extension
- Integration MediatR Extension
- Integration PlantUML IKVM
Configuration
- Tracking Dependencies
- Tracking Custom Dependencies
- HTTP Tracking Setup
- Report Configuration
- Diagram Customisation
- Phase-Aware Tracking
- Content Formatting
- PlantUML Server Configuration
Features
- Generated Reports
- Search Syntax
- Component Diagrams
- PlantUML Browser Rendering
- Inline SVG Rendering
- Internal Flow Tracking
- Tags and Attributes
- Excluding Requests
- Excluded Headers
- Multi-Host Test Architectures
- Event-Driven Architecture Testing
- Service Bus Tracking Patterns
- Background Thread Correlation
- Parallel-Safe Background Correlation
- Event & Message Tracking
- Assertion Tracking
- Step Tracking
- Tabular Attributes
- Large Response and Diagram Handling
- Diagnostics and Debugging
- CI Summary Integration
- CI Artifact Upload
Reference