GitHub App Installation

GitHub App Installation

Install the Crodox GitHub app in your GitHub Enterprise environment to grant Crodox access to your repositories.

---

About the Crodox App

The Crodox-DEV GitHub app enables Crodox to:

• Access your repositories
• Read code and parse structure
• Create pull requests from parsed selections
• Manage permissions per organization

---

Installation Process

Step 1 - Check GitHub Access

When you attempt to link your GitHub account in Crodox:

1. Go to Settings
2. Click Re-link GitHub (or during initial setup)
3. You will be redirected to GitHub Enterprise for authorization

Step 2 - Select Installation Target

If the Crodox app is not yet installed in your GitHub organization:

1. You will see "Where do you want to install Crodox-DEV?"
2. Select the GitHub organization or workspace where you want to install the app
3. Click the arrow to proceed with installation

Step 3 - Authorize App Permissions

On the authorization screen, you will see:

Repository Access:

• All repositories - Grant access to all current and future repositories (recommended)
• Only select repositories - Choose specific repositories to grant access

App Permissions:

• Read access to metadata
• Read and write access to administration, code, codespaces, and codespaces lifecycle admin

User Permissions:

• Read and write access to your profile

1. Select your preferred repository access level
2. Review the permissions listed
3. Click Install & Authorize to proceed
4. You will be redirected back to Crodox after authorization

---

Repository Requirements

Before creating a Workbench, ensure your GitHub repositories meet these requirements:

1. Template Repository - The repository must be marked as a Template Repository in GitHub Enterprise
2. Crodox App Access - The repository must be included in the Crodox app's access scope
3. Readable Content - The repository must contain source code that matches your Crodox grammar

See GitHub Repository Setup for instructions on configuring template repositories.

---

Troubleshooting

Issue: "Installation failed" or permission denied

Solution:

• Ensure you have admin permissions in the GitHub organization
• Check that your GitHub Enterprise instance allows third-party app installation
• Contact your GitHub Enterprise administrator if needed

Issue: App is installed but I can't see my repositories

Solution:

• Re-check Repository Access Management in Settings
• Ensure the repositories are included in the app's access scope
• Click Manage Repository Access to update permissions

---

See also: GitHub Integration - Repository management · GitHub Re-linking - Update app permissions