DOCSEARCHbyAlgolia
Submit Docs

Structurizr On-Premises

repository·main·Indexed 42 days ago

https://github.com/structurizr/onpremises

Documentation for the on-premises installation of Structurizr, including SAML authentication configuration via structurizr.properties. Note that this version is deprecated; users are encouraged to migrate to the Structurizr server.

Tokens
642
Snippets
3
Records
4
Agent score
3%

What's inside Structurizr

  2. Access Structurizr on-premises documentation

    main

    The official documentation for Structurizr on-premises has moved to a dedicated documentation site. For installation guides, API references, and usage instructions, visit the URL below.

    https://docs.structurizr.com/onpremises

  3. Configure SAML authentication in structurizr.properties

    main

    To enable SAML authentication in Structurizr on-premises, you must configure specific properties in your structurizr.properties file. The SAML configuration requires a metadata location and can optionally include an entity ID, signing certificates, and private keys for signing requests. You can also map SAML attributes to the application's username and role fields.

    Required properties:

    • saml.registrationId: A unique identifier for the SAML registration.
    • saml.metadata: The location (URL or file path) of the SAML metadata.

    Optional properties:

    • saml.entityId: The entity ID for the service provider.
    • saml.signingCertificate: The filename (relative to the data directory) of the X.509 signing certificate.
    • saml.signingPrivateKey: The filename (relative to the data directory) of the RSA private key.
    • saml.attribute.username: The name of the SAML attribute to be used as the username.
    • saml.attribute.role: The name of the SAML attribute to be used for roles.
    # Required
saml.registrationId=my-id
saml.metadata=https://idp.example.com/metadata

# Optional
saml.entityId=https://structurizr.example.com/saml/metadata
saml.signingCertificate=signing-cert.crt
saml.signingPrivateKey=signing-key.key
saml.attribute.username=uid
saml.attribute.role=groups