On-premises installation

Configuration

The following parameters can be set in the structurizr.properties file.

Name Description
structurizr.url URL
If the Structurizr dashboard is reporting an incorrect URL, which may happen if SSL termination is being handled upstream, this property can be used to override the URL.
structurizr.encryption Server-side encryption passphrase
By default, workspace data is stored as plaintext on disk. Setting this property will enable server-side encryption. For better security (and to keep the encryption passphrase away from the encrypted files), we recommend specifying this property as an environment variable (STRUCTURIZR_ENCRYPTION) or a JVM system property (structurizr.encryption), rather than putting this in the structurizr.properties file. You may need to patch your Java installation with the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files for encryption to work.
structurizr.admin Admin users and/or roles
By default, any authenticated user can create workspaces. If you would like to restrict who can create workspaces, set this property to a comma-separated list of usernames or roles that should have "admin" access.
structurizr.plantuml PlantUML server URL
The URL of a PlantUML installation (e.g. http://plantuml.com/plantuml).
structurizr.graphviz Graphviz integration
Whether the Graphviz integration should be enabled; true or false (default). If you would like to use the Graphviz integration for auto-layout, you will need to install Graphviz on your server (the dot command must be available from the command line).
structurizr.search Search implementation
The name of the search implementation to use: lucene (default), or elasticsearch (high availability add-on required; see On-premises installation - Elasticsearch for more details).