Install, update and uninstall the app

Install Mermaid Diagrams on your Confluence or Jira site, keep it up to date, and remove it when you no longer need it.

Before you begin

• You need to be a site admin, or a Confluence admin or Jira admin for the product you install it on.
• The Confluence and Jira apps are separate Marketplace listings with separate licenses. Install each one you need:
  • Mermaid Diagrams Macro for Confluence
  • Mermaid Diagrams for Jira

Install the app

1. In Confluence or Jira, select Apps > Explore more apps.
2. Search for Mermaid Diagrams, then select the app for your product.
3. Select Get app (or Try it free) and follow the prompts.

Result: The app works for everyone on the site straight away. In Confluence, people can insert the Mermaid Diagram macro. In Jira, they can add the Mermaid Diagrams panel from View app actions.

Update the app

Most updates reach your site automatically, with nothing to approve.

Some updates are major versions. They ask for new permissions or new data destinations, so Atlassian waits for an admin to approve them. Until then, the site keeps the previous version, and admins see App update available above diagrams.

1. Go to admin.atlassian.com and select your organization.
2. Select Apps > Sites > your site > Connected apps.
3. Find Apportunity: Mermaid Diagrams Macro for Confluence or Apportunity: Mermaid Diagrams for Jira, and approve the update.

To see what a major version changes before you approve it, see What's new and Data security and privacy.

Uninstall the app

1. In Connected apps, select View app details for the app.
2. Select Uninstall and confirm.

What happens to your diagrams:

• Confluence: diagram code and preview images are attachments of their pages, so they stay with the pages. Macros show nothing until you install the app again, and then they show the diagrams as before.
• Jira: diagrams in the Mermaid Diagrams panel are kept in Forge storage. Atlassian keeps them for 28 days after you uninstall, then deletes them. To get them back after reinstalling, contact support within 21 days of uninstalling.
• Mermaid code blocks in pages, descriptions and comments stay where they are, as code blocks.

warning

Uninstalling the Jira app starts the 28-day countdown for every panel diagram on the site. Reinstalling doesn't bring them back by itself.

Related

• The app's admin page: what the app stores and who can do what, on one page.
• Licensing: what happens when a license or trial ends.
• Data security and privacy: retention, residency and the app's permissions.