GitHub App Setup

# Hybrid Groups GitHub App Setup

1 Welcome
2 Create GitHub App
3 Install GitHub App

This setup guide will walk you through the process of creating and configuring the Hybrid Groups GitHub App in your GitHub account or organization.

You need a GitHub account to continue. If creating for an organization, you need owner permissions.

You must be logged in to GitHub on this browser. If you're not already logged in, please visit github.com/login first.

Create GitHub App

The Hybrid Groups GitHub App can be created in your personal account or an organization.

Fill out the form below and click Start App Creation to start the app creation process. You will be redirected to GitHub.

On GitHub click Create GitHub App for [account / organization] to complete the app creation process and be redirected back to this page.

App Name

Unique name for your GitHub App (e.g. 'my-hybrid-groups'). Use '@my-hybrid-groups' when mentioning the GitHub App in issues.

GitHub Organization (optional)

Organization name (optional). Leave empty for personal account.

## GitHub App Created Successfully!

App Name:

Install the GitHub App

Install the Github App in the repositories of your personal account or your organizations.

To start the installation, click Install App on GitHub at the bottom of this page. You will be redirected to GitHub. Follow these steps on GitHub to complete the setup process:

1. Choose account or organization

Choose the account or organization where you want to install the app.

2. Grant permissions

A permissions dialog will appear requesting repository access. Review the permissions and select the repositories the app can access. Click Install to authorize the app.

3. Copy the Installation ID

You will be redirected to the installation page showing the Installation ID in the URL (number after /installations/ , e.g. 75221500). Copy the Installation ID and paste it below.

→

Next step

Installation ID

## Setup Complete!

Your GitHub App has been configured successfully. GitHub App tokens and configuration settings have been saved to the application's .env file. A webhook was generated using smee.io to deliver GitHub events to your Hybrid Groups backend.

App Name:
Webhook URL:

Next Steps

🐳 Running with Docker

Start the application server:

`docker run -it --rm \
-v [your-data-dir]:/app/.data \
ghcr.io/gradion-ai/hybrid-groups:latest \
server github`

💻 Running without Docker

You need to:

1. Install the smee-client
2. Start webhook payload delivery:
   `smee -u -t http://127.0.0.1:8000/api/v1/github-webhook`
3. Start the Hybrid Groups backend:
   `python -m hygroup.scripts.server --gateway github`

Getting Started

Hybrid Groups is now active in all issues and PRs in the installed repositories.

Start using Hybrid Groups by following the introduction in the documentation.

You can close this window now.