# Install the app

> Installing Oktul Code Studio for Jira or for Confluence, connecting the other product, the permissions it asks for, and what happens when the licence lapses.
>
> Documentation for Oktul Code Studio, for Jira Cloud and Confluence Cloud, by Oktul: https://oktul.com/docs/plugins/code-studio/install/

<Aside type="caution">
Both Marketplace listings are awaiting Atlassian's approval. Until they are approved, the app
cannot be installed, and the steps below describe the listings as they will be.
</Aside>

Code Studio is an Atlassian Forge application. Nothing is deployed to your own infrastructure:
Atlassian hosts and runs it, and its storage is in your site.

## Choose a listing

**Oktul Code Studio for Jira** and **Oktul Code Studio for Confluence** are one app with the same
features. It is listed twice only because some sites have Jira and no Confluence, and others the
other way round. Install the listing for your site's main product, and only that one:

- **Your main product is Jira**: Oktul Code Studio for Jira. The console opens in Jira.
- **Your main product is Confluence**: Oktul Code Studio for Confluence. The console opens in
  Confluence.

Connect the other product to the same installation (below) and scripts, listeners, the
administration page, scripted fields and the automation action reach it too. Two things stay with
the listing:

- **The console** opens only in the main product.
- **Teamwork Graph publishing** for Rovo Search is in the Jira listing only.

<Aside type="caution" title="Never install both">
The two listings are two apps to Atlassian, and two apps never share storage. Installed side by
side, they are two separate Code Studios with their own scripts, settings and runs.
</Aside>

## Requirements

- Jira Cloud for the Jira listing, Confluence Cloud for the Confluence listing
- A site administrator to install it and approve its permissions
- An administrator of the required product to configure it: in the Jira listing, a Jira
  administrator; in the Confluence listing, a Confluence administrator

## Install it

<Steps
  items={[
    {
      title: 'Open the listing on the Atlassian Marketplace',
      body: 'Or, in the product, Apps, then Explore more apps, and search for Code Studio.',
    },
    {
      title: 'Install it on your site',
      body: 'A site administrator installs it. Anyone else can request it.',
    },
    {
      title: 'Approve the permissions',
      body: 'Atlassian shows the scopes and the hosts Code Studio may reach. Each is listed in privacy and data handling.',
    },
    {
      title: 'Open Code Studio from the Apps menu',
      body: 'The console opens on the list of spaces.',
    },
  ]}
/>

## The permissions

Code Studio asks for **93 scopes** in the Jira listing and **90** in the Confluence listing.

- **Why so many:** a script may call any documented Jira, Jira Service Management, Assets or
  Confluence REST operation, as ScriptRunner's can.
- **What is left out:** Forge installs at most 100 scopes, so nine rarely scripted operations are
  missing: Assets configuration and icons, Confluence app data, and deleting whiteboards, databases
  and smart links.
- **Why now:** a scope added after release is a major version every administrator approves again.

Users' email addresses are **not** among them: `read:email-address:jira` and
`read:email-address:confluence` would put every user's address within any script's reach. A
script that needs addresses cannot read them today.

The full list, with the purpose of each, is in [privacy and data handling](../privacy/#6-permissions).

## Confirm it worked

| Where | What |
|---|---|
| The required product's **Apps** menu | **Oktul Code Studio**, the console |
| Jira **Settings**, under **Apps**, or Confluence **Settings** | **Oktul Code Studio**, the administration page, for administrators |
| Jira automation, in the Jira listing or with Jira connected | The action **Run a Code Studio script** |

## Connecting the other product

Atlassian does not connect the other product by default. An organisation administrator connects
it in Atlassian Administration. Once connected, scripts reach it, its events can start listeners,
and the administration page appears there too. Who administers Code Studio is still decided by
the required product.

## Licensing, and what happens when it lapses

Paid, licensed per installation through the Atlassian Marketplace, with a free trial. The price for
your site's user tier is on the listing, and the charge is on your Atlassian invoice.

With no active licence, Code Studio stops and Jira and Confluence do not.

- **Refused:** the console, the administration page, listeners, schedules, API triggers, the
  automation action and the Rovo actions. No run starts.
- **Still runs:** the weekly personal data report, because the duty to erase a closed account does
  not lapse with the licence.
- **Nothing is deleted.**

## Removing the app

<Aside type="caution" title="Export before you uninstall">
Uninstalling removes Code Studio's Forge storage and secret store: scripts, runs, settings,
connections and their credentials. Export the configuration first, under **Import and export** on
the administration page. See [administration](../configure/#import-and-export).
</Aside>

## Common questions

**Should I install the Jira or the Confluence listing?**

The listing for your site's main product, and only that one. Connect the other product to the same installation.

**What happens if both listings are installed?**

They are two separate apps to Atlassian, with their own scripts, settings and runs, and never share storage.

**Can a script read users' email addresses?**

No. The app does not ask for the email address scopes, so no script can read them.

## Related

- [Administration](../configure/)
- [Scripts](../scripts/)
- [Privacy and data handling](../privacy/)

---

A problem or a question? Write to [support@oktul.com](mailto:support@oktul.com) or open a request in the [Help Center](https://oktul.atlassian.net/servicedesk/customer/portals). Both open a request with a reference and an SLA.