---
sidebar_label: Configuring GitHub organization
doc_id: 3a5b2c84-0a9c-4050-87bc-3c7dea56e2fa
description: >-
  Guide for installing nullplatform GitHub integration app to automate DevOps
  workflows and manage repositories.
keywords:
  - GitHub integration
  - nullplatform
  - DevOps automation
  - repository management
  - GitHub app
---

# Configuring GitHub organization

This guide walks you through the process of installing the [nullplatform GitHub integration app](https://github.com/apps/nullplatform-github-integration). This integration enables nullplatform to operate repositories on your behalf, automating essential DevOps workflows.

## Installation steps

1. Go to the [nullplatform GitHub integration app](https://github.com/apps/nullplatform-github-integration) and click **Install**.
2. Select the account or organization where you want to install the app.
3. Choose the repositories you want nullplatform to access:
   - All repositories: By specifying *all repositories*, we will be allowed not only to operate existing repositories but also create new ones.

## Record your Installation ID

Once the installation is complete, you'll be provided with an **Installation ID**.

:::warning Save your Installation ID securely
Make sure to **record your Installation ID**, as you'll need it later when configuring [Providers](/docs/providers/supported-integrations/code-repository/github-configuration) in nullplatform.
:::

## Understanding required permissions

The nullplatform GitHub integration requires specific permissions to operate effectively.

:::note Security notes
- These permissions represent the **minimum required** for nullplatform’s functionality.
- The app follows the **principle of least privilege**, requesting only what is essential for its operation.
:::

Here’s a breakdown of why each permission is necessary:

### Repository permissions

| Permission         | Access level | Purpose                                                                                  |
| ------------------ | ------------ |------------------------------------------------------------------------------------------|
| **Contents**       | Write        | Push code changes or content, such as Docker images|
| **Actions**        | Write        | Allow the notification system to trigger GitHub Actions workflows                        |
| **Secrets**        | Write        | Configure repositories with the nullplatform API key                                     |
| **Administration** | Write        | Create repositories and manage repository settings                                       |

### Organization permissions

| Permission                | Access level | Purpose                                                                                                                                                                     |
| ------------------------- | ------------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Administration**        | Read         | Allow us to read the organization, enabling the creation of repositories at the organization level                                                                          |
| **Organization webhooks** | Read & Write | Enables our system to receive organization-level webhook events for specific workflows<br />*(Note: This permission is deprecated but still used for legacy functionality)* |

## Next steps

After installation, use the Installation ID to configure [Providers](/docs/providers/overview) in nullplatform. This will establish the connection between your GitHub repositories and nullplatform's automation capabilities.

If you have any questions about the permissions or installation process, [reach out to us](/docs/support) for support.