> ## Documentation Index
> Fetch the complete documentation index at: https://www.oplane.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect GitHub

> Connect Oplane to your GitHub repositories to enable automated threat modeling on pull requests. The setup takes just a few minutes.

Connect Oplane to your GitHub repositories to enable automated threat modeling on pull requests. The setup takes just a few minutes.

<Steps>
  <Step title="Open Workspaces">
    Navigate to **Workspaces** in the left sidebar and click the **+ Workspace** button in the top right corner.

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/workspaces.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=4f52122d8df8dc5deca2f1da700c3e1b" alt="Oplane Workspaces page" width="3246" height="1866" data-path="images/connect-github/workspaces.webp" />
    </Frame>

    <Frame caption="Click the + Workspace button">
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/zoom-button.png?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=001602f1881b8f84478bcfce2fd040c6" alt="+ Workspace button" width="1024" height="854" data-path="images/connect-github/zoom-button.png" />
    </Frame>
  </Step>

  <Step title="Create a Managed Workspace">
    Select **Managed Workspace** and under Git Repository, click **Continue with GitHub** to connect your account.

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/setup.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=789cd3b6e17d77d52825dbd686694d9a" alt="Create a Managed Workspace with GitHub" width="964" height="737" data-path="images/connect-github/setup.webp" />
    </Frame>
  </Step>

  <Step title="Sign in to GitHub">
    You'll be redirected to GitHub to sign in. Enter your credentials or use one of the alternative sign-in methods (passkey, Google, Apple).

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/signin.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=bef5da6b4cc1e669f7a2d8e093f34783" alt="GitHub sign-in page" width="724" height="600" data-path="images/connect-github/signin.webp" />
    </Frame>
  </Step>

  <Step title="Install the Oplane GitHub App">
    GitHub will prompt you to install the Oplane Bot on your account or organisation. Choose which repositories Oplane should have access to, review the permissions, and click **Install**.

    Permissions granted: Read access to code, issues, and metadata. Read and write access to checks and pull requests — this is how Oplane posts review comments on your PRs.

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/install.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=e4267ed572d8cf294efd0baa46b4256c" alt="Install the Oplane GitHub App" width="749" height="885" data-path="images/connect-github/install.webp" />
    </Frame>
  </Step>

  <Step title="Select a Repository">
    Back in Oplane, select your organisation from the dropdown and search for the repository you want to connect.

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/search.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=f55b07a5ec8dc281dfc076238fd1ead3" alt="Select organisation and repository" width="958" height="657" data-path="images/connect-github/search.webp" />
    </Frame>
  </Step>

  <Step title="Configure the Workspace">
    Once connected, configure your workspace settings:

    * **Analyse Pull Requests** — Enable to automatically threat model every PR. If disabled, you can still trigger reviews by mentioning `@oplane` in a PR comment.
    * **Access** — Add team members who should have access to this workspace.

    Click **Create** when ready.

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/configure.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=81b77ebb227cce0ef42e25e5681adec7" alt="Configure workspace settings" width="947" height="920" data-path="images/connect-github/configure.webp" />
    </Frame>
  </Step>

  <Step title="Choose Threat Models">
    Oplane analyses your repository and suggests threat models based on the codebase. Select the ones relevant to your project, or describe your own scope. This step helps Oplane understand what to focus on in future PR reviews.

    <Frame>
      <img src="https://mintcdn.com/oplane-6a173d70/jwR0xubu7PkQElvJ/images/connect-github/suggest.webp?fit=max&auto=format&n=jwR0xubu7PkQElvJ&q=85&s=77cc6a67a698fccb907c236ed3cbc97b" alt="Choose threat models for your repository" width="801" height="899" data-path="images/connect-github/suggest.webp" />
    </Frame>
  </Step>
</Steps>

<Card title="What's next?" icon="git-pull-request" href="/github-prs">
  Learn how Oplane reviews your pull requests in the Pull & Merge Requests guide.
</Card>
