Browse documentation
Docs/Start here/Installing an app

Installing an app

The same five steps for every SynapseOasis app, and where its screens show up afterwards.

Installation is the same for all our apps, takes about a minute, and does not require any preparation on your side. Nothing is switched on until you configure it.

You need to be a Jira administrator
Only a Jira or site administrator can install apps. If you cannot see Apps in the top navigation, ask whoever administers your site.

Install

  1. 1In Jira, open Apps → Explore more apps. This opens the Atlassian Marketplace inside your site.
  2. 2Search for the app by name, for example Secret Scanner for Jira.
  3. 3Click Get it now, or Try it free to start a trial. Atlassian handles the trial and the billing; we never see a payment method.
  4. 4Review the permissions Atlassian lists and confirm. Those are the scopes explained on each app's reference page.
  5. 5Wait for the confirmation. The app is now installed on your site.

Where to find the app afterwards

Our apps put their screens in one of these places. Each app's overview page names the exact one.

Jira → Apps → app name
The global admin page. This is where Secret Scanner, License Waste Manager, Admin Toolkit, AI Triage and AI Portal Chat are configured.
Project settings → section
Configuration that belongs to one project, such as Select List Options or the per-desk AI Triage settings.
Settings → Issues → Custom fields
Where you create and configure the fields that Custom Fields Toolkit adds.
Settings → Issues → Workflows
Where you add Workflow Toolkit's condition, validator and post function to a transition.
On the issue itself
Panels and fields the apps add to the issue view, such as the AI Triage panel.
In Confluence
Markdown Toolkit adds an item to a space's sidebar, an entry in a page's ••• menu, and a macro you insert with /Markdown.
Nothing changes your issues until you say so
No app here modifies anything until it is configured. AI Triage routes nothing until you pick a service desk; every bulk action asks first. That is deliberate: an app that started changing your issues the moment it was installed would be a bad app. One app does start working immediately, and on purpose: Secret Scanner begins scanning as soon as it is installed, because a security app that waits is a security app that misses the week you forgot to switch it on. Scanning only reads — it flags findings for you and changes nothing — and the master switch on its Scanning Rules tab turns it off.

Try it somewhere safe first

Several of our tools change configuration or user access. If you have a test site, use it. If you do not, pick one small project and scope the app to it. Every guide tells you how to limit the scope.

Free test sites exist
You can create a free Atlassian Cloud site and install the app there on a trial. For anything involving deleting schemes, merging fields or suspending accounts, that hour of setup is cheaper than the alternative.

Uninstalling

Uninstall from Apps → Manage your apps. Two different things then happen to two different kinds of data:

  • What the app stored — configuration, results, its own records — is cleared by the app and detached by Atlassian immediately, then destroyed by Atlassian after its retention period. See Where your data goes for the exact behaviour.
  • What the app wrote into Jira or Confluence — issues it created, field values, comments, pages — stays where it is, because Atlassian owns that data and it is now ordinary Jira or Confluence content.
Reinstalling does not bring your settings back
A reinstall is treated as a brand new installation, so you configure the app again. If you uninstalled by accident, tell us within 21 days: Atlassian can re-link the previous data to the new installation, and we have to raise that request with your consent.

Something missing or wrong on this page? Tell us in the support portal or email contact@synapseoasis.com.