Structurizr

Structurizr is a "models as code" tool designed for the C4 model - you write Structurizr DSL to create multiple software architecture diagrams from a single model. Structurizr was created by the author of the C4 model and remains the reference implementation, making it the best choice if you are looking for compliance and compatibility with the C4 model.

• Structurizr DSL - Example
• Structurizr DSL - Tutorial

Quickstart

The two quickest ways to get started with the Structurizr tooling are:

1. Visit playground.structurizr.com to try Structurizr without installing any tooling.
2. Use Structurizr local via the pre-built Docker image to create diagrams on your computer - see local - Quickstart.

Documentation

See docs.structurizr.com for documentation, getting started guides, tutorials, etc.

Trimble Identity integration (enterprise hosting)

This repository can be configured for enterprise-hosted deployments that require:

• OIDC sign-in for the web UI.
• Token-based API authentication for workspace uploads.
• Admin-key based workspace creation and key-based pushes.

The key properties are:

structurizr.authentication=oidc

# OIDC web login
structurizr.authentication.oidc.issueruri=https://id.trimble.com
structurizr.authentication.oidc.clientid=<client-id>
structurizr.authentication.oidc.clientsecret=<client-secret-optional>
structurizr.authentication.oidc.scopes=openid,profile,email
structurizr.authentication.oidc.usernameclaim=email

# API upload token validation
structurizr.authentication.api.issueruri=https://id.trimble.com
structurizr.authentication.api.jwkseturi=https://id.trimble.com/.well-known/jwks.json
structurizr.authentication.api.audience=structurizr-upload
structurizr.authentication.api.scopes=structurizr.upload

# Optional migration fallback
structurizr.authentication.api.sharedtoken=

When configured, numeric-ID workspace uploads can pass a client-credentials OAuth access token via -key, e.g.:

java -jar structurizr-1.0.0.war push -url https://structurizr-app.example.com/api -id 2 -workspace ./workspace.json -key "$ACCESS_TOKEN" -merge false -archive true

For key-based pushes, define a stable workspace key in the workspace DSL:

workspace {
	properties {
		key "dewey"
	}
}

Then use push-key with the server admin key:

java -jar structurizr-1.0.0.war push-key -url https://structurizr-app.example.com/api -workspace ./workspace.json --adminApiKey "$ADMIN_API_KEY" -merge false -archive true

push-key reads properties.key from the workspace definition and creates or resolves the target workspace automatically. It does not accept -workspace-key.

Credential summary:

• push uses a workspace API key or configured API bearer token for an existing numeric workspace ID.
• push-key uses --adminApiKey with the server ADMIN_API_KEY because it may create the workspace before pushing to it.

Build

.\mvnw.cmd -pl structurizr-application -am -Pexclude-playwright -DskipTests package