Skip to main content

GitHub

GitHub is a web-based Git repository hosting service for version control and collaboration.

Authentication Types​

GitHub supports 4 authentication methods:

  • OAuth - Create your own GitHub OAuth app with custom scopes. Every user connects with their GitHub account.

    • Pros: Full control, per-user tracking, production-ready
    • Cons: ~2 min setup

  • Instant OAuth - Use Webrix's pre-configured GitHub app for the fastest setup.

    • Pros: Fastest setup, no configuration needed
    • Cons: Limited scopes, not recommended for production

  • API Key - Use a personal access token for all users.

    • Pros: Easy setup
    • Cons: Less secure, no per-user tracking

  • Server App - Use a GitHub App with installation-level access.

    • Pros: Best for organization-wide access, fine-grained permissions
    • Cons: More complex setup

Setting up OAuth​

  1. Go to https://github.com/settings/developers
  1. Click New OAuth App
  1. Fill in the application details:
    • Application name: Give it a descriptive name (e.g., "Webrix Integration")
    • Homepage URL: Your organization's website
    • Authorization callback URL: Copy the Redirect URL from Webrix

  1. Click Register application

  2. Copy the Client ID

  1. Click Generate a new client secret

  2. Copy the Client Secret immediately (it won't be shown again)

  1. In Webrix, paste the Client ID and Client Secret

  2. Select the scopes you need in Webrix

  3. Click Save Changes

Generating an API Key (Personal Access Token)​

  1. Go to https://github.com/settings/tokens
  1. Click Generate new token → Generate new token (classic) or Fine-grained token

  1. Give your token a descriptive name

  2. Select the scopes (permissions) you need

  1. Click Generate token

  2. Copy the token immediately and paste it into Webrix

Setting up a Server App (GitHub App)​

  1. Go to https://github.com/settings/apps

  1. Click New GitHub App

  2. Fill in the required details and permissions

  1. After creation, note the App ID and generate a Private Key

  2. Install the app on your organization/repositories

  3. Copy the Installation ID from the URL after installation

  4. In Webrix, enter the App ID, Private Key, and Installation ID