There are two ways to integrate diagrams from a Structurizr workspace into Atlassian Confluence.
The first is to use the built-in HTML Macro, although this needs to be enabled by an administrator on your Confluence installation. To embed a diagram, use the HTML embed code, which you can find by clicking the button while viewing the diagram you would like to embed.
The second approach is to use the Atlassian Confluence macros that have been built specifically to embed diagrams from Structurizr.
The macros can be installed via the Atlassian Marketplace, and are available for both Confluence Cloud and Server.
When editing a page, type
/structurizr (depending on the Confluence version) to insert the macro into your page.
You will need the following information:
- Workspace ID
- Workspace API key (from the workspace settings page)
- Diagram key (this is shown after the
#symbol when viewing a diagram)
Please note that diagram previews do not always display - you may need to save/publish the page.
Confluence Data Center
We do not have a dedicated version of the macro for installation on Confluence Data Center, predominantly due to the non-trivial certification process that plugins need to go through. Since the macros only generate HTML, they will work in a clustered environment. If the macros are unavailable to install via the Atlassian Marketplace, you can build/install your own version from GitHub.
The source code for the Confluence macros is open source and available on GitHub, should you want to review, customise or install them without using the Atlassian Marketplace.
When using the Structurizr macros for Atlassian Server or Cloud, none of the data you provide to the macros is stored by us.