On-premises installationOverview | Software architecture | Download | Deployment | Configuration | Troubleshooting | FAQ | EULA
Authentication | LDAP | SAML 2.0 | Authorisation and role-based access | HTTPS | Amazon Web Services S3 | Elasticsearch
The on-premises installation has two major configuration points - the location of the Structurizr data directory, and configuration of the on-premises installation itself via a file inside the Structurizr data directory.
Structurizr data directory
The location of the Structurizr data directory can be configured in a number of ways:
- An environment entry called
structurizr/dataDirectory(e.g. configured in
- An environment variable named
- A JVM system property named
If this is not set, the Structurizr data directory location will default to
The following parameters can be set in a text file named
structurizr.properties in your Structurizr data directory.
Changing these parameters generally requires a restart of the on-premises installation.
If you are running the on-premises installation behind a load balancer and/or reverse-proxy (e.g. SSL termination is being handled upstream), or the pages served by the on-premises installation don't look right (e.g. styles are not loading, images are oversized, etc), you will likely need to set this property to explicitly tell the on-premises installation the URL you are using to access it. This should be a full URL, such as
||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
The name of the authentication implementation to use:
||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.
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
Whether HTML should be filtered from workspace content; true (default) or false.
||Data storage implementation
The name of the data storage implementation to use:
The name of the search implementation to use: