# Bitbucket Install

Nullify is available as a Bitbucket App that can be installed across select repositories or all current and future repositories, allowing for workspace-wide coverage in one click.

Please reach out to our team to assist with your workspace setup.

## Install Nullify

### Setting up your Bitbucket App

1. Navigate to your Bitbucket workspace settings and go to **Apps and features**.

<figure><img src="https://3946391995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FId2OtLCL6O6V3XSRYxtr%2Fuploads%2Fgit-blob-f192360920f35adda11d085e6beebfafa73b3864%2Finstalled_apps.png?alt=media" alt="Bitbucket Apps and features page"><figcaption><p>Apps and features page</p></figcaption></figure>

2. Click on **Installed apps** in the left sidebar.
3. Enable **Development mode** by ticking the checkbox.
4. Click on **Install app from URL** and paste in the link provided by Nullify.

<figure><img src="https://3946391995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FId2OtLCL6O6V3XSRYxtr%2Fuploads%2Fgit-blob-9815e5710df684919d6a25a5bb7c4530418beada%2Finstall_app_from_url.png?alt=media" alt="Install app from URL button"><figcaption><p>Install app from URL</p></figcaption></figure>

<figure><img src="https://3946391995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FId2OtLCL6O6V3XSRYxtr%2Fuploads%2Fgit-blob-45ef5ff5b525055c0b0d5117f33f71eec24b35ca%2Finstall_app_from_url_modal.png?alt=media" alt="Install app from URL modal"><figcaption><p>Install app from URL modal</p></figcaption></figure>

### Creating an OAuth Consumer

5. Create an OAuth Consumer in Bitbucket by navigating to one of these URLs:
   * `https://bitbucket.org/account/settings/app-passwords`
   * `https://bitbucket.org/account/settings/oauth-consumers/`
6. Click **Add consumer**. You should be taken to a URL like: `https://bitbucket.org/your-org/workspace/settings/oauth-consumers/new`
7. Fill in the following details:

   **Name:** `Nullify`

   **Callback URL:** We will provide you this URL.
8. Grant the following **permissions**:

| **Permission**       | **Access**   | **Explanation**                                     |
| -------------------- | ------------ | --------------------------------------------------- |
| Account              | Read         | Required to access account information              |
| Workspace membership | Read         | Required to read workspace member information       |
| Projects             | Read & Write | Required to access and manage projects              |
| Repositories         | Read & Write | Required to review repositories and create comments |
| Pull Requests        | Read & Write | Required to create and modify pull request comments |
| Issues               | Read & Write | Required to create and modify issues                |
| Webhooks             | Read & Write | Required to set up webhooks for processing events   |

<figure><img src="https://3946391995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FId2OtLCL6O6V3XSRYxtr%2Fuploads%2Fgit-blob-5205cc097eb1c3103ff20d581b19d70089d582f4%2Fpermissions.png?alt=media" alt="OAuth consumer permissions"><figcaption><p>OAuth consumer permissions</p></figcaption></figure>

9. Click **Save** and copy the **Key** and **Secret**.
10. Send the Key and Secret to Nullify. This can be done via a password manager or secure communication channel.

### Final Steps

11. Wait for your stack to be provisioned by the Nullify team.
12. Once provisioned, you'll receive confirmation and can begin using Nullify to assess your Bitbucket repositories.

## Support

If you encounter any issues during the installation process, please contact our support team for assistance.
