Skip to content

Manual Installation

The manual installation flow is a setup wizard in the CodeLogic UI that connects a GitHub repository to CodeLogic without using the CodeLogic GitHub App. It walks you through credentials, webhooks, Change Request configuration, Renovate, and CI workflows step by step.

Use this path when the GitHub App is not an option—for example, organization policy blocks third-party GitHub Apps, or you use self-hosted GitHub Enterprise without marketplace access.

The CodeLogic GitHub App is the preferred integration when it is available. It requires less manual configuration in GitHub.

Prerequisites

Before you start, ensure you have:

  • A CodeLogic account with valid credentials (email and password).
  • The GitHub organization and repository you want to connect.
  • A GitHub bot or service account (or willingness to create one during setup). The wizard validates that the username exists on GitHub and recommends write access so the bot can post pull request comments and commit statuses.
  • Ability to create a fine-grained personal access token (PAT) on GitHub with the repository permissions listed below.
  • Admin access to the target repository settings (for webhooks and GitHub Environments).
  • The Renovate GitHub App installed on the repository (the wizard guides this step).
  • Familiarity with GitHub Actions—the wizard generates workflow YAML files that you commit to the repository.

Getting to the setup wizard

  1. Sign in to the CodeLogic UI.
  2. Open the setup wizard at /setup (full path /codelogic/ui/setup on a typical deployment).

After authentication, the minimal CodeLogic UI may redirect you to the setup wizard automatically. You can also open it from the Setup control on the change-request list.

Detailed instructions for each wizard step appear in the application. This documentation orients you to the flow; you do not need to complete every field before opening the wizard.

What the wizard covers

The wizard has three phases. You do not need to memorize the steps—the UI labels each tab and validates your progress.

Configuration

Six areas, which you can complete in any order:

Area Purpose
GitHub Repository Identifies the org and repo; CodeLogic creates a Scan Space and workspace named {org}/{repo} on the server.
GitHub User Dedicated bot account that owns the PAT and appears on pull requests.
Personal Access Token Fine-grained PAT stored as GitHub credentials on the CodeLogic server.
Renovate Installs and verifies the Renovate GitHub App for dependency upgrade pull requests.
Webhook Repository webhook pointing at your CodeLogic server for pull request events.
Change Request Config Links the repository, branch pattern, workspace, and credentials for Change Request analysis.

CI workflow setup

After configuration is complete, the wizard helps you:

  • Register a CodeLogic scan agent for CI use.
  • Create a GitHub Environment (CodeLogic Scan Env) with CODELOGIC_HOST, AGENT_UUID, and AGENT_PASSWORD.
  • Generate GitHub Actions workflow files (for example codelogic-main.yml and codelogic-renovate.yml) that scan pull request branches into the scan space {org}/{repo}.

Commit the generated workflows to your repository. See Configuring Agents for how scan data is matched to pull requests.

Completion

When setup is finished, Renovate can open upgrade pull requests and CodeLogic analyzes them through Change Requests. Optional CI build feedback uses Sending Build Info.

Fine-grained PAT permissions

When the wizard asks for a PAT, create a fine-grained token on GitHub (create a fine-grained PAT) scoped to the target repository. The wizard validates these permissions:

Permission Access Why CodeLogic needs it
Metadata Read Identify the repository (required by GitHub).
Code (Contents) Read and write Read repository files and participate in pull request workflows.
Commit statuses Read and write Report status on commits and pull requests.
Pull requests Read and write Receive and respond to pull request activity for Change Requests.
Webhooks Read and write Create and verify the repository webhook during setup.

Generate the token as the bot user configured in the wizard, not a personal developer account, when possible.